databoxedge.json

{
  "swagger": "2.0",
  "info": {
    "version": "2020-09-01-preview",
    "title": "DataBoxEdgeManagementClient"
  },
  "host": "management.azure.com",
  "schemes": [
    "https"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/providers/Microsoft.DataBoxEdge/operations": {
      "get": {
        "tags": [
          "Operations"
        ],
        "summary": "List all the supported operations.",
        "operationId": "Operations_List",
        "parameters": [
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "List of supported operations.",
            "schema": {
              "$ref": "#/definitions/OperationsList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        },
        "x-ms-examples": {
          "OperationsGet": {
            "$ref": "./examples/OperationsGet.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/availableSkus": {
      "get": {
        "tags": [
          "AvailableSkus"
        ],
        "summary": "List all the available Skus and information related to them.",
        "operationId": "AvailableSkus_List",
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "Lists the available Skus and information related to them.",
            "schema": {
              "$ref": "#/definitions/DataBoxEdgeSkuList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        },
        "x-ms-examples": {
          "AvailableSkus": {
            "$ref": "./examples/AvailableSkusList.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices": {
      "get": {
        "tags": [
          "Devices"
        ],
        "description": "Gets all the Data Box Edge/Data Box Gateway devices in a subscription.",
        "operationId": "Devices_ListBySubscription",
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Specify $expand=details to populate additional fields related to the resource or Specify $skipToken=<token> to populate the next page in the list.",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The collection of Data Box Edge/Data Box Gateway devices.",
            "schema": {
              "$ref": "#/definitions/DataBoxEdgeDeviceList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        },
        "x-ms-examples": {
          "DataBoxEdgeDeviceGetBySubscription": {
            "$ref": "./examples/DataBoxEdgeDeviceGetBySubscription.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices": {
      "get": {
        "tags": [
          "Devices"
        ],
        "description": "Gets all the Data Box Edge/Data Box Gateway devices in a resource group.",
        "operationId": "Devices_ListByResourceGroup",
        "parameters": [
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Specify $expand=details to populate additional fields related to the resource or Specify $skipToken=<token> to populate the next page in the list.",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The collection of Data Box Edge/Data Box Gateway devices.",
            "schema": {
              "$ref": "#/definitions/DataBoxEdgeDeviceList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        },
        "x-ms-examples": {
          "DataBoxEdgeDeviceGetByResourceGroup": {
            "$ref": "./examples/DataBoxEdgeDeviceGetByResourceGroup.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}": {
      "get": {
        "tags": [
          "Devices"
        ],
        "description": "Gets the properties of the Data Box Edge/Data Box Gateway device.",
        "operationId": "Devices_Get",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The Data Box Edge/Data Box Gateway device.",
            "schema": {
              "$ref": "#/definitions/DataBoxEdgeDevice"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-examples": {
          "DataBoxEdgeDeviceGetByName": {
            "$ref": "./examples/DataBoxEdgeDeviceGetByName.json"
          }
        }
      },
      "put": {
        "tags": [
          "Devices"
        ],
        "description": "Creates or updates a Data Box Edge/Data Box Gateway resource.",
        "operationId": "Devices_CreateOrUpdate",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "dataBoxEdgeDevice",
            "in": "body",
            "description": "The resource object.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/DataBoxEdgeDevice"
            }
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully created or updated the resource.",
            "schema": {
              "$ref": "#/definitions/DataBoxEdgeDevice"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "DataBoxEdgeDevicePut": {
            "$ref": "./examples/DataBoxEdgeDevicePut.json"
          }
        }
      },
      "delete": {
        "tags": [
          "Devices"
        ],
        "description": "Deletes the Data Box Edge/Data Box Gateway device.",
        "operationId": "Devices_Delete",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to delete the resource."
          },
          "204": {
            "description": "The resource is already deleted."
          },
          "200": {
            "description": "Successfully deleted the resource."
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "DataBoxEdgeDeviceDelete": {
            "$ref": "./examples/DataBoxEdgeDeviceDelete.json"
          }
        }
      },
      "patch": {
        "tags": [
          "Devices"
        ],
        "description": "Modifies a Data Box Edge/Data Box Gateway resource.",
        "operationId": "Devices_Update",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "parameters",
            "in": "body",
            "description": "The resource parameters.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/DataBoxEdgeDevicePatch"
            }
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully updated the resource.",
            "schema": {
              "$ref": "#/definitions/DataBoxEdgeDevice"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-examples": {
          "DataBoxEdgeDevicePatch": {
            "$ref": "./examples/DataBoxEdgeDevicePatch.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts": {
      "get": {
        "tags": [
          "Alerts"
        ],
        "description": "Gets all the alerts for a Data Box Edge/Data Box Gateway device.",
        "operationId": "Alerts_ListByDataBoxEdgeDevice",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The collection of alerts.",
            "schema": {
              "$ref": "#/definitions/AlertList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        },
        "x-ms-examples": {
          "AlertGetAllInDevice": {
            "$ref": "./examples/AlertGetAllInDevice.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts/{name}": {
      "get": {
        "tags": [
          "Alerts"
        ],
        "summary": "Gets an alert by name.",
        "operationId": "Alerts_Get",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "name",
            "in": "path",
            "description": "The alert name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The alert details.",
            "schema": {
              "$ref": "#/definitions/Alert"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-examples": {
          "AlertGet": {
            "$ref": "./examples/AlertGet.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules": {
      "get": {
        "tags": [
          "BandwidthSchedules"
        ],
        "description": "Gets all the bandwidth schedules for a Data Box Edge/Data Box Gateway device.",
        "operationId": "BandwidthSchedules_ListByDataBoxEdgeDevice",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The collection of bandwidth schedules.",
            "schema": {
              "$ref": "#/definitions/BandwidthSchedulesList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        },
        "x-ms-examples": {
          "BandwidthScheduleGetAllInDevice": {
            "$ref": "./examples/BandwidthScheduleGetAllInDevice.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}": {
      "get": {
        "tags": [
          "BandwidthSchedules"
        ],
        "description": "Gets the properties of the specified bandwidth schedule.",
        "operationId": "BandwidthSchedules_Get",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "name",
            "in": "path",
            "description": "The bandwidth schedule name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The bandwidth schedule.",
            "schema": {
              "$ref": "#/definitions/BandwidthSchedule"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-examples": {
          "BandwidthScheduleGet": {
            "$ref": "./examples/BandwidthScheduleGet.json"
          }
        }
      },
      "put": {
        "tags": [
          "BandwidthSchedules"
        ],
        "description": "Creates or updates a bandwidth schedule.",
        "operationId": "BandwidthSchedules_CreateOrUpdate",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "name",
            "in": "path",
            "description": "The bandwidth schedule name which needs to be added/updated.",
            "required": true,
            "type": "string"
          },
          {
            "name": "parameters",
            "in": "body",
            "description": "The bandwidth schedule to be added or updated.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/BandwidthSchedule"
            }
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to create or update the bandwidth schedule."
          },
          "200": {
            "description": "Successfully created or updated the bandwidth schedule.",
            "schema": {
              "$ref": "#/definitions/BandwidthSchedule"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "BandwidthSchedulePut": {
            "$ref": "./examples/BandwidthSchedulePut.json"
          }
        }
      },
      "delete": {
        "tags": [
          "BandwidthSchedules"
        ],
        "description": "Deletes the specified bandwidth schedule.",
        "operationId": "BandwidthSchedules_Delete",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "name",
            "in": "path",
            "description": "The bandwidth schedule name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to delete the bandwidth schedule."
          },
          "204": {
            "description": "Successfully deleted the bandwidth schedule."
          },
          "200": {
            "description": "Success"
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "BandwidthScheduleDelete": {
            "$ref": "./examples/BandwidthScheduleDelete.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/downloadUpdates": {
      "post": {
        "tags": [
          "Devices"
        ],
        "summary": "Downloads the updates on a Data Box Edge/Data Box Gateway device.",
        "operationId": "Devices_DownloadUpdates",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to download the updates on the device."
          },
          "200": {
            "description": "Successfully downloaded the updates on the device."
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "DownloadUpdatesPost": {
            "$ref": "./examples/DownloadUpdatesPost.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/generateCertificate": {
      "post": {
        "tags": [
          "Devices"
        ],
        "description": "Generates certificate for activation key.",
        "operationId": "Devices_GenerateCertificate",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully generated self signed certificate.",
            "schema": {
              "$ref": "#/definitions/GenerateCertResponse"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-examples": {
          "GenerateCertificate": {
            "$ref": "./examples/GenerateCertificate.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/getExtendedInformation": {
      "post": {
        "tags": [
          "Devices"
        ],
        "description": "Gets additional information for the specified Azure Stack Edge/Data Box Gateway device.",
        "operationId": "Devices_GetExtendedInformation",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The additional information.",
            "schema": {
              "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfo"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-examples": {
          "ExtendedInfoPost": {
            "$ref": "./examples/ExtendedInfoPost.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/installUpdates": {
      "post": {
        "tags": [
          "Devices"
        ],
        "summary": "Installs the updates on the Data Box Edge/Data Box Gateway device.",
        "operationId": "Devices_InstallUpdates",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to install updates on the device."
          },
          "200": {
            "description": "Successfully installed updates on the device."
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "InstallUpdatesPost": {
            "$ref": "./examples/InstallUpdatesPost.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/jobs/{name}": {
      "get": {
        "tags": [
          "Jobs"
        ],
        "summary": "Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.",
        "operationId": "Jobs_Get",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "name",
            "in": "path",
            "description": "The job name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The job details.",
            "schema": {
              "$ref": "#/definitions/Job"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-examples": {
          "JobsGet": {
            "$ref": "./examples/JobsGet.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/networkSettings/default": {
      "get": {
        "tags": [
          "Devices"
        ],
        "description": "Gets the network settings of the specified Data Box Edge/Data Box Gateway device.",
        "operationId": "Devices_GetNetworkSettings",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The device network settings.",
            "schema": {
              "$ref": "#/definitions/NetworkSettings"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-examples": {
          "NetworkSettingsGet": {
            "$ref": "./examples/NetworkSettingsGet.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/nodes": {
      "get": {
        "tags": [
          "Nodes"
        ],
        "description": "Gets all the nodes currently configured under this Data Box Edge device",
        "operationId": "Nodes_ListByDataBoxEdgeDevice",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The collection of all nodes on the device.",
            "schema": {
              "$ref": "#/definitions/NodeList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        },
        "x-ms-examples": {
          "NodesGetAllInDevice": {
            "$ref": "./examples/NodeGetAllInDevice.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/operationsStatus/{name}": {
      "get": {
        "tags": [
          "OperationsStatus"
        ],
        "summary": "Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.",
        "operationId": "OperationsStatus_Get",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "name",
            "in": "path",
            "description": "The job name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The job details.",
            "schema": {
              "$ref": "#/definitions/Job"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-examples": {
          "OperationsStatusGet": {
            "$ref": "./examples/OperationsStatusGet.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders": {
      "get": {
        "tags": [
          "Orders"
        ],
        "summary": "Lists all the orders related to a Data Box Edge/Data Box Gateway device.",
        "operationId": "Orders_ListByDataBoxEdgeDevice",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "Lists all the orders for the Data Box Edge Device",
            "schema": {
              "$ref": "#/definitions/OrderList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        },
        "x-ms-examples": {
          "OrderGetAllInDevice": {
            "$ref": "./examples/OrderGetAllInDevice.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default": {
      "get": {
        "tags": [
          "Orders"
        ],
        "summary": "Gets a specific order by name.",
        "operationId": "Orders_Get",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The order details of a device.",
            "schema": {
              "$ref": "#/definitions/Order"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-examples": {
          "OrderGet": {
            "$ref": "./examples/OrderGet.json"
          }
        }
      },
      "put": {
        "tags": [
          "Orders"
        ],
        "summary": "Creates or updates an order.",
        "operationId": "Orders_CreateOrUpdate",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The order details of a device.",
            "required": true,
            "type": "string"
          },
          {
            "name": "order",
            "in": "body",
            "description": "The order to be created or updated.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Order"
            }
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to create or update the order."
          },
          "200": {
            "description": "Successfully created or updated the order.",
            "schema": {
              "$ref": "#/definitions/Order"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "OrderPut": {
            "$ref": "./examples/OrderPut.json"
          }
        }
      },
      "delete": {
        "tags": [
          "Orders"
        ],
        "summary": "Deletes the order related to the device.",
        "operationId": "Orders_Delete",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to delete the order."
          },
          "204": {
            "description": "The order is already deleted."
          },
          "200": {
            "description": "Successfully deleted the order."
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "OrderDelete": {
            "$ref": "./examples/OrderDelete.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default/listDCAccessCode": {
      "post": {
        "tags": [
          "Orders"
        ],
        "summary": "Gets the DCAccess Code",
        "operationId": "Orders_ListDCAccessCode",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "DC Access code for the device",
            "schema": {
              "$ref": "#/definitions/DCAccessCode"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-examples": {
          "GetDCAccessCode": {
            "$ref": "./examples/GetDCAccessCode.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles": {
      "get": {
        "tags": [
          "Roles"
        ],
        "description": "Lists all the roles configured in a Data Box Edge/Data Box Gateway device.",
        "operationId": "Roles_ListByDataBoxEdgeDevice",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "List of all the roles configured in the device.",
            "schema": {
              "$ref": "#/definitions/RoleList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        },
        "x-ms-examples": {
          "RoleGetAllInDevice": {
            "$ref": "./examples/RoleGetAllInDevice.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}": {
      "get": {
        "tags": [
          "Roles"
        ],
        "description": "Gets a specific role by name.",
        "operationId": "Roles_Get",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "name",
            "in": "path",
            "description": "The role name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The role with the specified name in the given device.",
            "schema": {
              "$ref": "#/definitions/Role"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-examples": {
          "RoleGet": {
            "$ref": "./examples/RoleGet.json"
          }
        }
      },
      "put": {
        "tags": [
          "Roles"
        ],
        "description": "Create or update a role.",
        "operationId": "Roles_CreateOrUpdate",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "name",
            "in": "path",
            "description": "The role name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "role",
            "in": "body",
            "description": "The role properties.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Role"
            }
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to create or update the role."
          },
          "200": {
            "description": "Successfully created or updated the role.",
            "schema": {
              "$ref": "#/definitions/Role"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "RolePut": {
            "$ref": "./examples/RolePut.json"
          }
        }
      },
      "delete": {
        "tags": [
          "Roles"
        ],
        "description": "Deletes the role on the device.",
        "operationId": "Roles_Delete",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "name",
            "in": "path",
            "description": "The role name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to delete the role."
          },
          "204": {
            "description": "The role is already deleted."
          },
          "200": {
            "description": "Successfully deleted the role."
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "RoleDelete": {
            "$ref": "./examples/RoleDelete.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons": {
      "get": {
        "tags": [
          "Addons"
        ],
        "description": "Lists all the addons configured in the role.",
        "operationId": "Addons_ListByRole",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "roleName",
            "in": "path",
            "description": "The role name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "List of all the addons configured in the role.",
            "schema": {
              "$ref": "#/definitions/AddonList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        },
        "x-ms-examples": {
          "RoleListAddOns": {
            "$ref": "./examples/RoleListAddOns.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/addons/{addonName}": {
      "get": {
        "tags": [
          "Addons"
        ],
        "description": "Gets a specific addon by name.",
        "operationId": "Addons_Get",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "roleName",
            "in": "path",
            "description": "The role name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "addonName",
            "in": "path",
            "description": "The addon name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The addon with the specified name in the role.",
            "schema": {
              "$ref": "#/definitions/Addon"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-examples": {
          "GetAddons": {
            "$ref": "./examples/GetAddons.json"
          }
        }
      },
      "put": {
        "tags": [
          "Addons"
        ],
        "description": "Create or update a addon.",
        "operationId": "Addons_CreateOrUpdate",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "roleName",
            "in": "path",
            "description": "The role name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "addonName",
            "in": "path",
            "description": "The addon name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "addon",
            "in": "body",
            "description": "The addon properties.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Addon"
            }
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to create or update the addon."
          },
          "200": {
            "description": "Successfully created or updated the addon.",
            "schema": {
              "$ref": "#/definitions/Addon"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "PutAddons": {
            "$ref": "./examples/PutAddons.json"
          }
        }
      },
      "delete": {
        "tags": [
          "Addons"
        ],
        "description": "Deletes the addon on the device.",
        "operationId": "Addons_Delete",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "roleName",
            "in": "path",
            "description": "The role name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "addonName",
            "in": "path",
            "description": "The addon name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to delete the addon."
          },
          "204": {
            "description": "The addon is already deleted."
          },
          "200": {
            "description": "Successfully deleted the addon."
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-long-running-operation-options": {
          "final-state-via": "location"
        },
        "x-ms-examples": {
          "DeleteAddons": {
            "$ref": "./examples/DeleteAddons.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig": {
      "get": {
        "tags": [
          "MonitoringConfig"
        ],
        "summary": "Lists metric configurations in a role.",
        "operationId": "MonitoringConfig_List",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "roleName",
            "in": "path",
            "description": "The role name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The monitoring config details.",
            "schema": {
              "$ref": "#/definitions/MonitoringMetricConfigurationList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        },
        "x-ms-examples": {
          "ListMonitoringConfig": {
            "$ref": "./examples/ListMonitoringConfig.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{roleName}/monitoringConfig/default": {
      "get": {
        "tags": [
          "MonitoringConfig"
        ],
        "summary": "Gets a  metric configuration of a role.",
        "operationId": "MonitoringConfig_Get",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "roleName",
            "in": "path",
            "description": "The role name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The monitoring config details.",
            "schema": {
              "$ref": "#/definitions/MonitoringMetricConfiguration"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-examples": {
          "GetMonitoringConfig": {
            "$ref": "./examples/GetMonitoringConfig.json"
          }
        }
      },
      "put": {
        "tags": [
          "MonitoringConfig"
        ],
        "summary": "Creates a new metric configuration or updates an existing one for a role.",
        "operationId": "MonitoringConfig_CreateOrUpdate",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "roleName",
            "in": "path",
            "description": "The role name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "monitoringMetricConfiguration",
            "in": "body",
            "description": "The metric configuration.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/MonitoringMetricConfiguration"
            }
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to create or update the metrics configuration."
          },
          "200": {
            "description": "Successfully created or updated the metrics configuration.",
            "schema": {
              "$ref": "#/definitions/MonitoringMetricConfiguration"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "PutMonitoringConfig": {
            "$ref": "./examples/PutMonitoringConfig.json"
          }
        }
      },
      "delete": {
        "tags": [
          "MonitoringConfig"
        ],
        "summary": "deletes a new metric configuration for a role.",
        "operationId": "MonitoringConfig_Delete",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "roleName",
            "in": "path",
            "description": "The role name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully deleted the metrics configuration."
          },
          "202": {
            "description": "Accepted the request to delete the metrics configuration."
          },
          "204": {
            "description": "The metrics configuration is already deleted."
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "DeleteMonitoringConfig": {
            "$ref": "./examples/DeleteMonitoringConfig.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/scanForUpdates": {
      "post": {
        "tags": [
          "Devices"
        ],
        "summary": "Scans for updates on a Data Box Edge/Data Box Gateway device.",
        "operationId": "Devices_ScanForUpdates",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to scan for updates on the device."
          },
          "200": {
            "description": "Successfully scanned the device for updates."
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "ScanForUpdatesPost": {
            "$ref": "./examples/ScanForUpdatesPost.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/securitySettings/default/update": {
      "post": {
        "tags": [
          "Devices"
        ],
        "description": "Updates the security settings on a Data Box Edge/Data Box Gateway device.",
        "operationId": "Devices_CreateOrUpdateSecuritySettings",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "securitySettings",
            "in": "body",
            "description": "The security settings.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/SecuritySettings"
            }
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to update the security settings."
          },
          "204": {
            "description": "Updated the security settings."
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "CreateOrUpdateSecuritySettings": {
            "$ref": "./examples/SecuritySettingsUpdatePost.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares": {
      "get": {
        "tags": [
          "Shares"
        ],
        "summary": "Lists all the shares in a Data Box Edge/Data Box Gateway device.",
        "operationId": "Shares_ListByDataBoxEdgeDevice",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The collection of all the shares on the device.",
            "schema": {
              "$ref": "#/definitions/ShareList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        },
        "x-ms-examples": {
          "ShareGetAllInDevice": {
            "$ref": "./examples/ShareGetAllInDevice.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}": {
      "get": {
        "tags": [
          "Shares"
        ],
        "summary": "Gets a share by name.",
        "operationId": "Shares_Get",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "name",
            "in": "path",
            "description": "The share name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The share details.",
            "schema": {
              "$ref": "#/definitions/Share"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-examples": {
          "ShareGet": {
            "$ref": "./examples/ShareGet.json"
          }
        }
      },
      "put": {
        "tags": [
          "Shares"
        ],
        "summary": "Creates a new share or updates an existing share on the device.",
        "operationId": "Shares_CreateOrUpdate",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "name",
            "in": "path",
            "description": "The share name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "share",
            "in": "body",
            "description": "The share properties.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Share"
            }
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to create or update the share."
          },
          "200": {
            "description": "Successfully created or updated the share.",
            "schema": {
              "$ref": "#/definitions/Share"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "SharePut": {
            "$ref": "./examples/SharePut.json"
          }
        }
      },
      "delete": {
        "tags": [
          "Shares"
        ],
        "description": "Deletes the share on the Data Box Edge/Data Box Gateway device.",
        "operationId": "Shares_Delete",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "name",
            "in": "path",
            "description": "The share name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to delete the share."
          },
          "204": {
            "description": "The share is already deleted."
          },
          "200": {
            "description": "Successfully deleted the share."
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "ShareDelete": {
            "$ref": "./examples/ShareDelete.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}/refresh": {
      "post": {
        "tags": [
          "Shares"
        ],
        "summary": "Refreshes the share metadata with the data from the cloud.",
        "operationId": "Shares_Refresh",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "name",
            "in": "path",
            "description": "The share name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to refresh the share on the device."
          },
          "200": {
            "description": "Successfully refreshed the share on the device."
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "ShareRefreshPost": {
            "$ref": "./examples/ShareRefreshPost.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials": {
      "get": {
        "tags": [
          "StorageAccountCredentials"
        ],
        "summary": "Gets all the storage account credentials in a Data Box Edge/Data Box Gateway device.",
        "operationId": "StorageAccountCredentials_ListByDataBoxEdgeDevice",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The collection of storage account credentials.",
            "schema": {
              "$ref": "#/definitions/StorageAccountCredentialList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        },
        "x-ms-examples": {
          "SACGetAllInDevice": {
            "$ref": "./examples/SACGetAllInDevice.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}": {
      "get": {
        "tags": [
          "StorageAccountCredentials"
        ],
        "description": "Gets the properties of the specified storage account credential.",
        "operationId": "StorageAccountCredentials_Get",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "name",
            "in": "path",
            "description": "The storage account credential name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The storage account credential properties.",
            "schema": {
              "$ref": "#/definitions/StorageAccountCredential"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-examples": {
          "SACGet": {
            "$ref": "./examples/SACGet.json"
          }
        }
      },
      "put": {
        "tags": [
          "StorageAccountCredentials"
        ],
        "description": "Creates or updates the storage account credential.",
        "operationId": "StorageAccountCredentials_CreateOrUpdate",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "name",
            "in": "path",
            "description": "The storage account credential name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "storageAccountCredential",
            "in": "body",
            "description": "The storage account credential.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/StorageAccountCredential"
            }
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to create or update the storage account credential."
          },
          "200": {
            "description": "Successfully created or updated the storage account credential.",
            "schema": {
              "$ref": "#/definitions/StorageAccountCredential"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "SACPut": {
            "$ref": "./examples/SACPut.json"
          }
        }
      },
      "delete": {
        "tags": [
          "StorageAccountCredentials"
        ],
        "description": "Deletes the storage account credential.",
        "operationId": "StorageAccountCredentials_Delete",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "name",
            "in": "path",
            "description": "The storage account credential name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to delete the storage account credential."
          },
          "204": {
            "description": "The storage account credential is already deleted."
          },
          "200": {
            "description": "Successfully deleted the storage account credential."
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "SACDelete": {
            "$ref": "./examples/SACDelete.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts": {
      "get": {
        "tags": [
          "StorageAccounts"
        ],
        "summary": "Lists all the StorageAccounts in a Data Box Edge/Data Box Gateway device.",
        "operationId": "StorageAccounts_ListByDataBoxEdgeDevice",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The collection of all the StorageAccounts on the device.",
            "schema": {
              "$ref": "#/definitions/StorageAccountList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        },
        "x-ms-examples": {
          "StorageAccountGetAllInDevice": {
            "$ref": "./examples/StorageAccountGetAllInDevice.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}": {
      "get": {
        "tags": [
          "StorageAccounts"
        ],
        "summary": "Gets a StorageAccount by name.",
        "operationId": "StorageAccounts_Get",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "storageAccountName",
            "in": "path",
            "description": "The storage account name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The storage account details.",
            "schema": {
              "$ref": "#/definitions/StorageAccount"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-examples": {
          "StorageAccountGet": {
            "$ref": "./examples/StorageAccountGet.json"
          }
        }
      },
      "put": {
        "tags": [
          "StorageAccounts"
        ],
        "summary": "Creates a new StorageAccount or updates an existing StorageAccount on the device.",
        "operationId": "StorageAccounts_CreateOrUpdate",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "storageAccountName",
            "in": "path",
            "description": "The StorageAccount name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "storageAccount",
            "in": "body",
            "description": "The StorageAccount properties.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/StorageAccount"
            }
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to create or update the StorageAccount."
          },
          "200": {
            "description": "Successfully created or updated the StorageAccount.",
            "schema": {
              "$ref": "#/definitions/StorageAccount"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "StorageAccountPut": {
            "$ref": "./examples/StorageAccountPut.json"
          }
        }
      },
      "delete": {
        "tags": [
          "StorageAccounts"
        ],
        "description": "Deletes the StorageAccount on the Data Box Edge/Data Box Gateway device.",
        "operationId": "StorageAccounts_Delete",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "storageAccountName",
            "in": "path",
            "description": "The StorageAccount name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to delete the StorageAccount."
          },
          "204": {
            "description": "The StorageAccount is already deleted."
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "StorageAccountDelete": {
            "$ref": "./examples/StorageAccountDelete.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers": {
      "get": {
        "tags": [
          "Containers"
        ],
        "summary": "Lists all the containers of a storage Account in a Data Box Edge/Data Box Gateway device.",
        "operationId": "Containers_ListByStorageAccount",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "storageAccountName",
            "in": "path",
            "description": "The storage Account name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The collection of all the containers on the device.",
            "schema": {
              "$ref": "#/definitions/ContainerList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        },
        "x-ms-examples": {
          "ContainerListAllInDevice": {
            "$ref": "./examples/ContainerListAllInDevice.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}": {
      "get": {
        "tags": [
          "Containers"
        ],
        "summary": "Gets a container by name.",
        "operationId": "Containers_Get",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "storageAccountName",
            "in": "path",
            "description": "The Storage Account Name",
            "required": true,
            "type": "string"
          },
          {
            "name": "containerName",
            "in": "path",
            "description": "The container Name",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The container details.",
            "schema": {
              "$ref": "#/definitions/Container"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-examples": {
          "ContainerGet": {
            "$ref": "./examples/ContainerGet.json"
          }
        }
      },
      "put": {
        "tags": [
          "Containers"
        ],
        "summary": "Creates a new container or updates an existing container on the device.",
        "operationId": "Containers_CreateOrUpdate",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "storageAccountName",
            "in": "path",
            "description": "The Storage Account Name",
            "required": true,
            "type": "string"
          },
          {
            "name": "containerName",
            "in": "path",
            "description": "The container name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "container",
            "in": "body",
            "description": "The container properties.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Container"
            }
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to create or update the container."
          },
          "200": {
            "description": "Successfully created or updated the container.",
            "schema": {
              "$ref": "#/definitions/Container"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "ContainerPut": {
            "$ref": "./examples/ContainerPut.json"
          }
        }
      },
      "delete": {
        "tags": [
          "Containers"
        ],
        "description": "Deletes the container on the Data Box Edge/Data Box Gateway device.",
        "operationId": "Containers_Delete",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "storageAccountName",
            "in": "path",
            "description": "The Storage Account Name",
            "required": true,
            "type": "string"
          },
          {
            "name": "containerName",
            "in": "path",
            "description": "The container name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to delete the container."
          },
          "204": {
            "description": "The container is already deleted."
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "ContainerDelete": {
            "$ref": "./examples/ContainerDelete.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}/refresh": {
      "post": {
        "tags": [
          "Containers"
        ],
        "summary": "Refreshes the container metadata with the data from the cloud.",
        "operationId": "Containers_Refresh",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "storageAccountName",
            "in": "path",
            "description": "The Storage Account Name",
            "required": true,
            "type": "string"
          },
          {
            "name": "containerName",
            "in": "path",
            "description": "The container name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to refresh the container on the device."
          },
          "200": {
            "description": "Successfully refreshed the container on the device."
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "ContainerRefresh": {
            "$ref": "./examples/ContainerRefresh.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers": {
      "get": {
        "tags": [
          "Triggers"
        ],
        "description": "Lists all the triggers configured in the device.",
        "operationId": "Triggers_ListByDataBoxEdgeDevice",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Specify $filter='CustomContextTag eq <tag>' to filter on custom context tag property",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "List all the triggers configured in the device",
            "schema": {
              "$ref": "#/definitions/TriggerList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        },
        "x-ms-examples": {
          "TriggerGetAllInDevice": {
            "$ref": "./examples/TriggerGetAllInDevice.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}": {
      "get": {
        "tags": [
          "Triggers"
        ],
        "description": "Get a specific trigger by name.",
        "operationId": "Triggers_Get",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "name",
            "in": "path",
            "description": "The trigger name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The trigger.",
            "schema": {
              "$ref": "#/definitions/Trigger"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-examples": {
          "TriggerGet": {
            "$ref": "./examples/TriggerGet.json"
          }
        }
      },
      "put": {
        "tags": [
          "Triggers"
        ],
        "description": "Creates or updates a trigger.",
        "operationId": "Triggers_CreateOrUpdate",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "Creates or updates a trigger",
            "required": true,
            "type": "string"
          },
          {
            "name": "name",
            "in": "path",
            "description": "The trigger name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "trigger",
            "in": "body",
            "description": "The trigger.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Trigger"
            }
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to create or update the trigger."
          },
          "200": {
            "description": "Successfully created or updated the trigger.",
            "schema": {
              "$ref": "#/definitions/Trigger"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "TriggerPut": {
            "$ref": "./examples/TriggerPut.json"
          }
        }
      },
      "delete": {
        "tags": [
          "Triggers"
        ],
        "description": "Deletes the trigger on the gateway device.",
        "operationId": "Triggers_Delete",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "name",
            "in": "path",
            "description": "The trigger name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to delete the trigger."
          },
          "204": {
            "description": "The trigger is already deleted."
          },
          "200": {
            "description": "Successfully deleted the trigger."
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "TriggerDelete": {
            "$ref": "./examples/TriggerDelete.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateExtendedInformation": {
      "post": {
        "tags": [
          "Devices"
        ],
        "description": "Gets additional information for the specified Data Box Edge/Data Box Gateway device.",
        "operationId": "Devices_UpdateExtendedInformation",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "parameters",
            "in": "body",
            "description": "The patch object.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfoPatch"
            }
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "Modify additional information.",
            "schema": {
              "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfo"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-examples": {
          "GetUpdateExtendedInfo": {
            "$ref": "./examples/GetUpdateExtendedInfo.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateSummary/default": {
      "get": {
        "tags": [
          "Devices"
        ],
        "summary": "Gets information about the availability of updates based on the last scan of the device. It also gets information about any ongoing download or install jobs on the device.",
        "operationId": "Devices_GetUpdateSummary",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The update summary.",
            "schema": {
              "$ref": "#/definitions/UpdateSummary"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-examples": {
          "UpdateSummaryGet": {
            "$ref": "./examples/UpdateSummaryGet.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/uploadCertificate": {
      "post": {
        "tags": [
          "Devices"
        ],
        "description": "Uploads registration certificate for the device.",
        "operationId": "Devices_UploadCertificate",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "parameters",
            "in": "body",
            "description": "The upload certificate request.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/UploadCertificateRequest"
            }
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully uploaded the registration certificate.",
            "schema": {
              "$ref": "#/definitions/UploadCertificateResponse"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-examples": {
          "UploadCertificatePost": {
            "$ref": "./examples/UploadCertificatePost.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users": {
      "get": {
        "tags": [
          "Users"
        ],
        "description": "Gets all the users registered on a Data Box Edge/Data Box Gateway device.",
        "operationId": "Users_ListByDataBoxEdgeDevice",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Specify $expand=details to populate additional fields related to the resource or Specify $skipToken=<token> to populate the next page in the list.",
            "required": false,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "The collection of all users on the device.",
            "schema": {
              "$ref": "#/definitions/UserList"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-pageable": {
          "nextLinkName": "nextLink"
        },
        "x-ms-examples": {
          "UserGetAllInDevice": {
            "$ref": "./examples/UserGetAllInDevice.json"
          }
        }
      }
    },
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}": {
      "get": {
        "tags": [
          "Users"
        ],
        "description": "Gets the properties of the specified user.",
        "operationId": "Users_Get",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "name",
            "in": "path",
            "description": "The user name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "The user details.",
            "schema": {
              "$ref": "#/definitions/User"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-examples": {
          "UserGet": {
            "$ref": "./examples/UserGet.json"
          }
        }
      },
      "put": {
        "tags": [
          "Users"
        ],
        "description": "Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.",
        "operationId": "Users_CreateOrUpdate",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "name",
            "in": "path",
            "description": "The user name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "user",
            "in": "body",
            "description": "The user details.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/User"
            }
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to create or update the user."
          },
          "200": {
            "description": "Successfully created or updated the user.",
            "schema": {
              "$ref": "#/definitions/User"
            }
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "UserPut": {
            "$ref": "./examples/UserPut.json"
          }
        }
      },
      "delete": {
        "tags": [
          "Users"
        ],
        "description": "Deletes the user on a databox edge/gateway device.",
        "operationId": "Users_Delete",
        "parameters": [
          {
            "name": "deviceName",
            "in": "path",
            "description": "The device name.",
            "required": true,
            "type": "string"
          },
          {
            "name": "name",
            "in": "path",
            "description": "The user name.",
            "required": true,
            "type": "string"
          },
          {
            "$ref": "#/parameters/subscriptionIdParameter"
          },
          {
            "$ref": "#/parameters/resourceGroupNameParameter"
          },
          {
            "$ref": "#/parameters/apiVersionParameter"
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted the request to delete the user."
          },
          "204": {
            "description": "The user is already deleted."
          },
          "200": {
            "description": "Successfully deleted the user."
          },
          "default": {
            "description": "Error response describing why the operation failed.",
            "schema": {
              "$ref": "#/definitions/CloudError"
            }
          }
        },
        "x-ms-long-running-operation": true,
        "x-ms-examples": {
          "UserDelete": {
            "$ref": "./examples/UserDelete.json"
          }
        }
      }
    }
  },
  "definitions": {
    "Addon": {
      "description": "Role Addon",
      "required": [
        "kind"
      ],
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/ARMBaseModel"
        }
      ],
      "properties": {
        "kind": {
          "description": "Addon type.",
          "enum": [
            "IotEdge",
            "ArcForKubernetes"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "AddonType",
            "modelAsString": true
          }
        },
        "systemData": {
          "description": "Addon type",
          "$ref": "#/definitions/SystemData"
        }
      },
      "discriminator": "kind"
    },
    "AddonList": {
      "description": "Collection of all the Role addon on the Azure Stack Edge device.",
      "type": "object",
      "properties": {
        "value": {
          "description": "The Value.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/Addon"
          },
          "readOnly": true
        },
        "nextLink": {
          "description": "Link to the next set of results.",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "Address": {
      "description": "The shipping address of the customer.",
      "required": [
        "country"
      ],
      "type": "object",
      "properties": {
        "addressLine1": {
          "description": "The address line1.",
          "type": "string"
        },
        "addressLine2": {
          "description": "The address line2.",
          "type": "string"
        },
        "addressLine3": {
          "description": "The address line3.",
          "type": "string"
        },
        "postalCode": {
          "description": "The postal code.",
          "type": "string"
        },
        "city": {
          "description": "The city name.",
          "type": "string"
        },
        "state": {
          "description": "The state name.",
          "type": "string"
        },
        "country": {
          "description": "The country name.",
          "type": "string"
        }
      }
    },
    "Alert": {
      "description": "Alert on the data box edge/gateway device.",
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/ARMBaseModel"
        }
      ],
      "properties": {
        "systemData": {
          "description": "Alert generated in the resource",
          "$ref": "#/definitions/SystemData"
        },
        "properties": {
          "$ref": "#/definitions/AlertProperties",
          "description": "Properties of alert.",
          "readOnly": true,
          "x-ms-client-flatten": true
        }
      }
    },
    "AlertErrorDetails": {
      "description": "Error details for the alert.",
      "type": "object",
      "properties": {
        "errorCode": {
          "description": "Error code.",
          "type": "string",
          "readOnly": true
        },
        "errorMessage": {
          "description": "Error Message.",
          "type": "string",
          "readOnly": true
        },
        "occurrences": {
          "format": "int32",
          "description": "Number of occurrences.",
          "type": "integer",
          "readOnly": true
        }
      }
    },
    "AlertList": {
      "description": "Collection of alerts.",
      "type": "object",
      "properties": {
        "value": {
          "description": "The value.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/Alert"
          },
          "readOnly": true
        },
        "nextLink": {
          "description": "Link to the next set of results.",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "AlertProperties": {
      "description": "Properties of alert.",
      "type": "object",
      "properties": {
        "title": {
          "description": "Alert title.",
          "type": "string",
          "readOnly": true
        },
        "alertType": {
          "description": "Alert type.",
          "type": "string",
          "readOnly": true
        },
        "appearedAtDateTime": {
          "format": "date-time",
          "description": "UTC time when the alert appeared.",
          "type": "string",
          "readOnly": true
        },
        "recommendation": {
          "description": "Alert recommendation.",
          "type": "string",
          "readOnly": true
        },
        "severity": {
          "description": "Severity of the alert.",
          "enum": [
            "Informational",
            "Warning",
            "Critical"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "AlertSeverity",
            "modelAsString": true
          }
        },
        "errorDetails": {
          "$ref": "#/definitions/AlertErrorDetails",
          "description": "Error details of the alert.",
          "readOnly": true
        },
        "detailedInformation": {
          "description": "Alert details.",
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "readOnly": true
        }
      }
    },
    "ArcAddon": {
      "description": "Arc Addon.",
      "required": [
        "properties",
        "kind"
      ],
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/Addon"
        }
      ],
      "properties": {
        "properties": {
          "$ref": "#/definitions/ArcAddonProperties",
          "description": "Properties specific to Arc addon.",
          "x-ms-client-flatten": true
        },
        "id": {
          "description": "The path ID that uniquely identifies the object.",
          "type": "string",
          "readOnly": true
        },
        "name": {
          "description": "The object name.",
          "type": "string",
          "readOnly": true
        },
        "type": {
          "description": "The hierarchical type of the object.",
          "type": "string",
          "readOnly": true
        }
      },
      "x-ms-discriminator-value": "ArcForKubernetes"
    },
    "ArcAddonProperties": {
      "description": "Arc addon properties.",
      "required": [
        "subscriptionId",
        "resourceGroupName",
        "resourceName",
        "resourceLocation"
      ],
      "type": "object",
      "properties": {
        "subscriptionId": {
          "description": "Arc resource subscription Id",
          "type": "string"
        },
        "resourceGroupName": {
          "description": "Arc resource group name",
          "type": "string"
        },
        "resourceName": {
          "description": "Arc resource Name",
          "type": "string"
        },
        "resourceLocation": {
          "description": "Arc resource location",
          "type": "string"
        },
        "version": {
          "description": "Arc resource version",
          "type": "string",
          "readOnly": true
        },
        "hostPlatform": {
          "description": "Host OS supported by the Arc addon.",
          "enum": [
            "Windows",
            "Linux"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "PlatformType",
            "modelAsString": true
          }
        },
        "hostPlatformType": {
          "description": "Platform where the runtime is hosted.",
          "enum": [
            "KubernetesCluster",
            "LinuxVM"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "HostPlatformType",
            "modelAsString": true
          }
        },
        "provisioningState": {
          "description": "Addon Provisioning State",
          "enum": [
            "Invalid",
            "Creating",
            "Created",
            "Updating",
            "Reconfiguring",
            "Failed",
            "Deleting"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "AddonState",
            "modelAsString": true
          }
        }
      }
    },
    "ARMBaseModel": {
      "description": "Represents the base class for all object models.",
      "type": "object",
      "properties": {
        "id": {
          "description": "The path ID that uniquely identifies the object.",
          "type": "string",
          "readOnly": true
        },
        "name": {
          "description": "The object name.",
          "type": "string",
          "readOnly": true
        },
        "type": {
          "description": "The hierarchical type of the object.",
          "type": "string",
          "readOnly": true
        }
      },
      "x-ms-azure-resource": true
    },
    "AsymmetricEncryptedSecret": {
      "description": "Represent the secrets intended for encryption with asymmetric key pair.",
      "required": [
        "value",
        "encryptionAlgorithm"
      ],
      "type": "object",
      "properties": {
        "value": {
          "description": "The value of the secret.",
          "x-ms-secret": true,
          "type": "string"
        },
        "encryptionCertThumbprint": {
          "description": "Thumbprint certificate used to encrypt \\\"Value\\\". If the value is unencrypted, it will be null.",
          "type": "string"
        },
        "encryptionAlgorithm": {
          "description": "The algorithm used to encrypt \"Value\".",
          "enum": [
            "None",
            "AES256",
            "RSAES_PKCS1_v_1_5"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "EncryptionAlgorithm",
            "modelAsString": true
          }
        }
      }
    },
    "Authentication": {
      "description": "Authentication mechanism for IoT devices.",
      "type": "object",
      "properties": {
        "symmetricKey": {
          "$ref": "#/definitions/SymmetricKey",
          "description": "Symmetric key for authentication."
        }
      }
    },
    "AzureContainerInfo": {
      "description": "Azure container mapping of the endpoint.",
      "required": [
        "storageAccountCredentialId",
        "containerName",
        "dataFormat"
      ],
      "type": "object",
      "properties": {
        "storageAccountCredentialId": {
          "description": "ID of the storage account credential used to access storage.",
          "type": "string"
        },
        "containerName": {
          "description": "Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob).",
          "type": "string"
        },
        "dataFormat": {
          "description": "Storage format used for the file represented by the share.",
          "enum": [
            "BlockBlob",
            "PageBlob",
            "AzureFile"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "AzureContainerDataFormat",
            "modelAsString": true
          }
        }
      }
    },
    "BandwidthSchedule": {
      "description": "The bandwidth schedule details.",
      "required": [
        "properties"
      ],
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/ARMBaseModel"
        }
      ],
      "properties": {
        "systemData": {
          "description": "Bandwidth object related to ASE resource",
          "$ref": "#/definitions/SystemData"
        },
        "properties": {
          "$ref": "#/definitions/BandwidthScheduleProperties",
          "description": "The properties of the bandwidth schedule.",
          "x-ms-client-flatten": true
        }
      }
    },
    "BandwidthScheduleProperties": {
      "description": "The properties of the bandwidth schedule.",
      "required": [
        "start",
        "stop",
        "rateInMbps",
        "days"
      ],
      "type": "object",
      "properties": {
        "start": {
          "description": "The start time of the schedule in UTC.",
          "type": "string"
        },
        "stop": {
          "description": "The stop time of the schedule in UTC.",
          "type": "string"
        },
        "rateInMbps": {
          "format": "int32",
          "description": "The bandwidth rate in Mbps.",
          "type": "integer"
        },
        "days": {
          "description": "The days of the week when this schedule is applicable.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "enum": [
              "Sunday",
              "Monday",
              "Tuesday",
              "Wednesday",
              "Thursday",
              "Friday",
              "Saturday"
            ],
            "type": "string",
            "x-ms-enum": {
              "name": "DayOfWeek",
              "modelAsString": true
            }
          }
        }
      }
    },
    "BandwidthSchedulesList": {
      "description": "The collection of bandwidth schedules.",
      "type": "object",
      "properties": {
        "value": {
          "description": "The list of bandwidth schedules.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/BandwidthSchedule"
          },
          "readOnly": true
        },
        "nextLink": {
          "description": "Link to the next set of results.",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "ClientAccessRight": {
      "description": "The mapping between a particular client IP and the type of access client has on the NFS share.",
      "required": [
        "client",
        "accessPermission"
      ],
      "type": "object",
      "properties": {
        "client": {
          "description": "IP of the client.",
          "type": "string"
        },
        "accessPermission": {
          "description": "Type of access to be allowed for the client.",
          "enum": [
            "NoAccess",
            "ReadOnly",
            "ReadWrite"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "ClientPermissionType",
            "modelAsString": true
          }
        }
      }
    },
    "CloudEdgeManagementRole": {
      "description": "CloudEdgeManagementRole role.",
      "required": [
        "kind"
      ],
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/Role"
        }
      ],
      "properties": {
        "properties": {
          "$ref": "#/definitions/CloudEdgeManagementRoleProperties",
          "description": "Properties specific to CloudEdgeManagementRole role.",
          "x-ms-client-flatten": true
        },
        "id": {
          "description": "The path ID that uniquely identifies the object.",
          "type": "string",
          "readOnly": true
        },
        "name": {
          "description": "The object name.",
          "type": "string",
          "readOnly": true
        },
        "type": {
          "description": "The hierarchical type of the object.",
          "type": "string",
          "readOnly": true
        }
      },
      "x-ms-discriminator-value": "CloudEdgeManagement"
    },
    "CloudEdgeManagementRoleProperties": {
      "description": "CloudEdgeManagement Role properties.",
      "required": [
        "roleStatus"
      ],
      "type": "object",
      "properties": {
        "localManagementStatus": {
          "description": "Local Edge Management Status",
          "enum": [
            "Enabled",
            "Disabled"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "RoleStatus",
            "modelAsString": true
          }
        },
        "edgeProfile": {
          "$ref": "#/definitions/EdgeProfile",
          "description": "Edge Profile of the resource",
          "readOnly": true
        },
        "roleStatus": {
          "description": "Role status.",
          "enum": [
            "Enabled",
            "Disabled"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "RoleStatus",
            "modelAsString": true
          }
        }
      }
    },
    "CloudError": {
      "description": "An error response from the service.",
      "properties": {
        "error": {
          "$ref": "#/definitions/CloudErrorBody",
          "description": "The error details."
        }
      },
      "x-ms-external": true
    },
    "CloudErrorBody": {
      "description": "An error response from the service.",
      "properties": {
        "code": {
          "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically.",
          "type": "string"
        },
        "message": {
          "description": "A message describing the error, intended to be suitable for display in a user interface.",
          "type": "string"
        },
        "details": {
          "description": "A list of additional details about the error.",
          "type": "array",
          "items": {
            "$ref": "#/definitions/CloudErrorBody"
          }
        }
      },
      "x-ms-external": true
    },
    "CniConfig": {
      "description": "Cni configuration",
      "type": "object",
      "properties": {
        "type": {
          "description": "Cni type",
          "type": "string",
          "readOnly": true
        },
        "version": {
          "description": "Cni version",
          "type": "string",
          "readOnly": true
        },
        "podSubnet": {
          "description": "Pod Subnet",
          "type": "string",
          "readOnly": true
        },
        "serviceSubnet": {
          "description": "Service subnet",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "ComputeResource": {
      "description": "Compute infrastructure Resource",
      "required": [
        "processorCount",
        "memoryInGB"
      ],
      "type": "object",
      "properties": {
        "processorCount": {
          "format": "int32",
          "description": "Processor count",
          "type": "integer"
        },
        "memoryInGB": {
          "format": "int64",
          "description": "Memory in GB",
          "type": "integer"
        }
      }
    },
    "ContactDetails": {
      "description": "Contains all the contact details of the customer.",
      "required": [
        "contactPerson",
        "companyName",
        "phone",
        "emailList"
      ],
      "type": "object",
      "properties": {
        "contactPerson": {
          "description": "The contact person name.",
          "type": "string"
        },
        "companyName": {
          "description": "The name of the company.",
          "type": "string"
        },
        "phone": {
          "description": "The phone number.",
          "type": "string"
        },
        "emailList": {
          "description": "The email list.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "Container": {
      "description": "Represents a container on the  Data Box Edge/Gateway device.",
      "required": [
        "properties"
      ],
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/ARMBaseModel"
        }
      ],
      "properties": {
        "systemData": {
          "description": "Container in DataBoxEdge Resource",
          "$ref": "#/definitions/SystemData"
        },
        "properties": {
          "$ref": "#/definitions/ContainerProperties",
          "description": "The container properties.",
          "x-ms-client-flatten": true
        }
      }
    },
    "ContainerList": {
      "description": "Collection of all the containers on the Data Box Edge/Gateway device.",
      "type": "object",
      "properties": {
        "value": {
          "description": "The list of containers.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/Container"
          },
          "readOnly": true
        },
        "nextLink": {
          "description": "Link to the next set of results.",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "ContainerProperties": {
      "description": "The container properties.",
      "required": [
        "dataFormat"
      ],
      "type": "object",
      "properties": {
        "containerStatus": {
          "description": "Current status of the container.",
          "enum": [
            "OK",
            "Offline",
            "Unknown",
            "Updating",
            "NeedsAttention"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "ContainerStatus",
            "modelAsString": true
          }
        },
        "dataFormat": {
          "description": "DataFormat for Container",
          "enum": [
            "BlockBlob",
            "PageBlob",
            "AzureFile"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "AzureContainerDataFormat",
            "modelAsString": true
          }
        },
        "refreshDetails": {
          "$ref": "#/definitions/RefreshDetails",
          "description": "Details of the refresh job on this container.",
          "readOnly": true
        },
        "createdDateTime": {
          "format": "date-time",
          "description": "The UTC time when container got created.",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "DataBoxEdgeDevice": {
      "description": "The Data Box Edge/Gateway device.",
      "required": [
        "location"
      ],
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/ARMBaseModel"
        }
      ],
      "properties": {
        "location": {
          "description": "The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed.",
          "type": "string",
          "x-ms-mutability": [
            "read",
            "create"
          ]
        },
        "tags": {
          "description": "The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).",
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "sku": {
          "$ref": "#/definitions/Sku",
          "description": "The SKU type."
        },
        "etag": {
          "description": "The etag for the devices.",
          "type": "string"
        },
        "identity": {
          "$ref": "#/definitions/ResourceIdentity",
          "description": "Msi identity of the resource"
        },
        "kind": {
          "description": "The etag for the devices.",
          "enum": [
            "AzureDataBoxGateway",
            "AzureStackEdge",
            "AzureStackHub",
            "AzureModularDataCentre"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "DataBoxEdgeDeviceKind",
            "modelAsString": true
          }
        },
        "systemData": {
          "description": "DataBoxEdge Resource",
          "$ref": "#/definitions/SystemData"
        },
        "properties": {
          "$ref": "#/definitions/DataBoxEdgeDeviceProperties",
          "description": "The properties of the Data Box Edge/Gateway device.",
          "x-ms-client-flatten": true
        }
      }
    },
    "DataBoxEdgeDeviceExtendedInfo": {
      "description": "The extended Info of the Data Box Edge/Gateway device.",
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/ARMBaseModel"
        }
      ],
      "properties": {
        "properties": {
          "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfoProperties",
          "description": "The extended info properties.",
          "x-ms-client-flatten": true
        }
      }
    },
    "DataBoxEdgeDeviceExtendedInfoPatch": {
      "description": "The Data Box Edge/Gateway device extended info patch.",
      "type": "object",
      "properties": {
        "clientSecretStoreId": {
          "description": "The Key Vault ARM Id for client secrets",
          "type": "string"
        },
        "clientSecretStoreUrl": {
          "description": "The url to access the Client Key Vault",
          "type": "string"
        },
        "channelIntegrityKeyName": {
          "description": "The name for Channel Integrity Key stored in the Client Key Vault",
          "type": "string"
        },
        "channelIntegrityKeyVersion": {
          "description": "The version of Channel Integrity Key stored in the Client Key Vault",
          "type": "string"
        }
      }
    },
    "DataBoxEdgeDeviceExtendedInfoProperties": {
      "description": "The properties of the Data Box Edge/Gateway device extended info.",
      "type": "object",
      "properties": {
        "encryptionKeyThumbprint": {
          "description": "The digital signature of encrypted certificate.",
          "type": "string"
        },
        "encryptionKey": {
          "description": "The public part of the encryption certificate. Client uses this to encrypt any secret.",
          "type": "string"
        },
        "resourceKey": {
          "description": "The Resource ID of the Resource.",
          "type": "string",
          "readOnly": true
        },
        "clientSecretStoreId": {
          "description": "The Key Vault ARM Id for client secrets",
          "type": "string"
        },
        "clientSecretStoreUrl": {
          "description": "The url to access the Client Key Vault",
          "type": "string"
        },
        "channelIntegrityKeyName": {
          "description": "The name of Channel Integrity Key stored in the Client Key Vault",
          "type": "string"
        },
        "channelIntegrityKeyVersion": {
          "description": "The version of Channel Integrity Key stored in the Client Key Vault",
          "type": "string"
        }
      }
    },
    "DataBoxEdgeDeviceList": {
      "description": "The collection of Data Box Edge/Gateway devices.",
      "type": "object",
      "properties": {
        "value": {
          "description": "The list of Data Box Edge/Gateway devices.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/DataBoxEdgeDevice"
          },
          "readOnly": true
        },
        "nextLink": {
          "description": "Link to the next set of results.",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "DataBoxEdgeDevicePatch": {
      "description": "The Data Box Edge/Gateway device patch.",
      "type": "object",
      "properties": {
        "tags": {
          "description": "The tags attached to the Data Box Edge/Gateway resource.",
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "identity": {
          "$ref": "#/definitions/ResourceIdentity",
          "description": "Msi identity of the resource"
        },
        "properties": {
          "$ref": "#/definitions/DataBoxEdgeDevicePropertiesPatch",
          "description": "The properties associated with the Data Box Edge/Gateway resource",
          "x-ms-client-flatten": true
        }
      }
    },
    "DataBoxEdgeDeviceProperties": {
      "description": "The properties of the Data Box Edge/Gateway device.",
      "type": "object",
      "properties": {
        "dataBoxEdgeDeviceStatus": {
          "description": "The status of the Data Box Edge/Gateway device.",
          "enum": [
            "ReadyToSetup",
            "Online",
            "Offline",
            "NeedsAttention",
            "Disconnected",
            "PartiallyDisconnected",
            "Maintenance"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "DataBoxEdgeDeviceStatus",
            "modelAsString": true
          }
        },
        "serialNumber": {
          "description": "The Serial Number of Data Box Edge/Gateway device.",
          "type": "string",
          "readOnly": true
        },
        "description": {
          "description": "The Description of the Data Box Edge/Gateway device.",
          "type": "string"
        },
        "modelDescription": {
          "description": "The description of the Data Box Edge/Gateway device model.",
          "type": "string"
        },
        "deviceType": {
          "description": "The type of the Data Box Edge/Gateway device.",
          "enum": [
            "DataBoxEdgeDevice"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "DeviceType",
            "modelAsString": true
          }
        },
        "friendlyName": {
          "description": "The Data Box Edge/Gateway device name.",
          "type": "string"
        },
        "culture": {
          "description": "The Data Box Edge/Gateway device culture.",
          "type": "string",
          "readOnly": true
        },
        "deviceModel": {
          "description": "The Data Box Edge/Gateway device model.",
          "type": "string",
          "readOnly": true
        },
        "deviceSoftwareVersion": {
          "description": "The Data Box Edge/Gateway device software version.",
          "type": "string",
          "readOnly": true
        },
        "deviceLocalCapacity": {
          "format": "int64",
          "description": "The Data Box Edge/Gateway device local capacity in MB.",
          "type": "integer",
          "readOnly": true
        },
        "timeZone": {
          "description": "The Data Box Edge/Gateway device timezone.",
          "type": "string",
          "readOnly": true
        },
        "deviceHcsVersion": {
          "description": "The device software version number of the device (eg: 1.2.18105.6).",
          "type": "string",
          "readOnly": true
        },
        "configuredRoleTypes": {
          "description": "Type of compute roles configured.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "enum": [
              "IOT",
              "ASA",
              "Functions",
              "Cognitive",
              "MEC",
              "CloudEdgeManagement",
              "Kubernetes"
            ],
            "type": "string",
            "x-ms-enum": {
              "name": "RoleTypes",
              "modelAsString": true
            }
          },
          "readOnly": true
        },
        "nodeCount": {
          "format": "int32",
          "description": "The number of nodes in the cluster.",
          "type": "integer",
          "readOnly": true
        },
        "resourceMoveDetails": {
          "$ref": "#/definitions/ResourceMoveDetails",
          "description": "The details of the move operation on this resource."
        },
        "edgeProfile": {
          "$ref": "#/definitions/EdgeProfile",
          "description": "The details of Edge Profile for this resource"
        }
      }
    },
    "DataBoxEdgeDevicePropertiesPatch": {
      "description": "The Data Box Edge/Gateway device properties patch.",
      "type": "object",
      "properties": {
        "edgeProfile": {
          "$ref": "#/definitions/EdgeProfilePatch",
          "description": "Edge Profile property of the Data Box Edge/Gateway device"
        }
      }
    },
    "DataBoxEdgeMoveRequest": {
      "description": "Resource Move details",
      "required": [
        "targetResourceGroup",
        "resources"
      ],
      "type": "object",
      "properties": {
        "targetResourceGroup": {
          "description": "Target resource group ARMId",
          "type": "string"
        },
        "resources": {
          "description": "List of resources to be moved",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "DataBoxEdgeSku": {
      "description": "The Sku information.",
      "type": "object",
      "properties": {
        "resourceType": {
          "description": "The type of the resource.",
          "type": "string",
          "readOnly": true
        },
        "name": {
          "description": "The Sku name.",
          "enum": [
            "Gateway",
            "Edge",
            "TEA_1Node",
            "TEA_1Node_UPS",
            "TEA_1Node_Heater",
            "TEA_1Node_UPS_Heater",
            "TEA_4Node_Heater",
            "TEA_4Node_UPS_Heater",
            "TMA",
            "TDC",
            "TCA_Small",
            "GPU",
            "TCA_Large",
            "EdgeP_Base",
            "EdgeP_High",
            "EdgePR_Base",
            "EdgePR_Base_UPS",
            "EdgeMR_Mini",
            "RCA_Small",
            "RCA_Large",
            "RDC"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "SkuName",
            "modelAsString": true
          }
        },
        "kind": {
          "description": "The Sku kind.",
          "type": "string",
          "readOnly": true
        },
        "tier": {
          "description": "The Sku tier.",
          "enum": [
            "Standard"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "SkuTier",
            "modelAsString": true
          }
        },
        "size": {
          "description": "The Sku kind.",
          "type": "string",
          "readOnly": true
        },
        "family": {
          "description": "The Sku family.",
          "type": "string",
          "readOnly": true
        },
        "locations": {
          "description": "Availability of the Sku for the region.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "type": "string"
          },
          "readOnly": true
        },
        "apiVersions": {
          "description": "The API versions in which Sku is available.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "type": "string"
          },
          "readOnly": true
        },
        "locationInfo": {
          "description": "Availability of the Sku for the location/zone/site.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/SkuLocationInfo"
          },
          "readOnly": true
        },
        "costs": {
          "description": "The pricing info of the Sku.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/SkuCost"
          },
          "readOnly": true
        },
        "signupOption": {
          "description": "Sku can be signed up by customer or not.",
          "enum": [
            "None",
            "Available"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "SkuSignupOption",
            "modelAsString": true
          }
        },
        "version": {
          "description": "Availability of the Sku as preview/stable.",
          "enum": [
            "Stable",
            "Preview"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "SkuVersion",
            "modelAsString": true
          }
        },
        "availability": {
          "description": "Links to the next set of results",
          "enum": [
            "Available",
            "Unavailable"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "SkuAvailability",
            "modelAsString": true
          }
        },
        "shipmentTypes": {
          "description": "List of Shipment Types supported by this SKU",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "enum": [
              "NotApplicable",
              "ShippedToCustomer",
              "SelfPickup"
            ],
            "type": "string",
            "x-ms-enum": {
              "name": "ShipmentType",
              "modelAsString": true
            }
          },
          "readOnly": true
        }
      }
    },
    "DataBoxEdgeSkuList": {
      "description": "List of SKU Information objects.",
      "type": "object",
      "properties": {
        "value": {
          "description": "List of ResourceType Sku",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/DataBoxEdgeSku"
          },
          "readOnly": true
        },
        "nextLink": {
          "description": "Links to the next set of results",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "DCAccessCode": {
      "description": "DC Access code in the case of Self Managed Shipping.",
      "type": "object",
      "properties": {
        "properties": {
          "$ref": "#/definitions/DCAccessCodeProperties",
          "description": "DCAccessCode properties.",
          "x-ms-client-flatten": true
        }
      }
    },
    "DCAccessCodeProperties": {
      "description": "DCAccessCode Properties.",
      "type": "object",
      "properties": {
        "authCode": {
          "description": "DCAccess Code for the Self Managed shipment.",
          "type": "string"
        }
      }
    },
    "EdgeProfile": {
      "description": "Details about Edge Profile for the resource",
      "type": "object",
      "properties": {
        "subscription": {
          "$ref": "#/definitions/EdgeProfileSubscription",
          "description": "Edge Profile Subscription"
        }
      }
    },
    "EdgeProfilePatch": {
      "description": "The Data Box Edge/Gateway Edge Profile patch.",
      "type": "object",
      "properties": {
        "subscription": {
          "$ref": "#/definitions/EdgeProfileSubscriptionPatch",
          "description": "The Data Box Edge/Gateway Edge Profile Subscription patch"
        }
      }
    },
    "EdgeProfileSubscription": {
      "description": "Subscription details for the Edge Profile",
      "type": "object",
      "properties": {
        "registrationId": {
          "description": "Edge Subscription Registration ID",
          "type": "string"
        },
        "id": {
          "description": "ARM ID of the subscription",
          "type": "string"
        },
        "state": {
          "enum": [
            "Registered",
            "Warned",
            "Suspended",
            "Deleted",
            "Unregistered"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "SubscriptionState",
            "modelAsString": true
          }
        },
        "registrationDate": {
          "type": "string"
        },
        "subscriptionId": {
          "type": "string"
        },
        "properties": {
          "$ref": "#/definitions/SubscriptionProperties",
          "x-ms-client-flatten": true
        }
      }
    },
    "EdgeProfileSubscriptionPatch": {
      "description": "The Data Box Edge/Gateway Edge Profile Subscription patch.",
      "type": "object",
      "properties": {
        "id": {
          "description": "The path ID that uniquely identifies the subscription of the edge profile.",
          "type": "string"
        }
      }
    },
    "EtcdInfo": {
      "description": "Etcd configuration",
      "type": "object",
      "properties": {
        "type": {
          "description": "Etcd type",
          "type": "string",
          "readOnly": true
        },
        "version": {
          "description": "Etcd version",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "FileEventTrigger": {
      "description": "Trigger details.",
      "required": [
        "properties",
        "kind"
      ],
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/Trigger"
        }
      ],
      "properties": {
        "properties": {
          "$ref": "#/definitions/FileTriggerProperties",
          "description": "File trigger properties.",
          "x-ms-client-flatten": true
        },
        "id": {
          "description": "The path ID that uniquely identifies the object.",
          "type": "string",
          "readOnly": true
        },
        "name": {
          "description": "The object name.",
          "type": "string",
          "readOnly": true
        },
        "type": {
          "description": "The hierarchical type of the object.",
          "type": "string",
          "readOnly": true
        }
      },
      "x-ms-discriminator-value": "FileEvent"
    },
    "FileSourceInfo": {
      "description": "File source details.",
      "required": [
        "shareId"
      ],
      "type": "object",
      "properties": {
        "shareId": {
          "description": "File share ID.",
          "type": "string"
        }
      }
    },
    "FileTriggerProperties": {
      "description": "File trigger properties.",
      "required": [
        "sourceInfo",
        "sinkInfo"
      ],
      "type": "object",
      "properties": {
        "sourceInfo": {
          "$ref": "#/definitions/FileSourceInfo",
          "description": "File event source details."
        },
        "sinkInfo": {
          "$ref": "#/definitions/RoleSinkInfo",
          "description": "Role sink info."
        },
        "customContextTag": {
          "description": "A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module.",
          "maxLength": 192,
          "type": "string"
        }
      }
    },
    "GenerateCertResponse": {
      "description": "Used in activation key generation flow.",
      "type": "object",
      "properties": {
        "publicKey": {
          "description": "Gets or sets base64 encoded certificate raw data,\r\nthis is the public part needed to be uploaded to cert vault",
          "type": "string"
        },
        "privateKey": {
          "description": "Gets or sets base64 encoded private part of the certificate,\r\nneeded to form the activation key",
          "x-ms-secret": true,
          "type": "string"
        },
        "expiryTimeInUTC": {
          "description": "Gets or sets expiry time in UTC",
          "type": "string"
        }
      }
    },
    "ImageRepositoryCredential": {
      "description": "Image repository credential.",
      "required": [
        "imageRepositoryUrl",
        "userName"
      ],
      "type": "object",
      "properties": {
        "imageRepositoryUrl": {
          "description": "Image repository url (e.g.: mcr.microsoft.com).",
          "type": "string"
        },
        "userName": {
          "description": "Repository user name.",
          "type": "string"
        },
        "password": {
          "$ref": "#/definitions/AsymmetricEncryptedSecret",
          "description": "Repository user password."
        }
      }
    },
    "IoTAddon": {
      "description": "IoT Addon.",
      "required": [
        "properties",
        "kind"
      ],
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/Addon"
        }
      ],
      "properties": {
        "properties": {
          "$ref": "#/definitions/IoTAddonProperties",
          "description": "Properties specific to IOT addon.",
          "x-ms-client-flatten": true
        },
        "id": {
          "description": "The path ID that uniquely identifies the object.",
          "type": "string",
          "readOnly": true
        },
        "name": {
          "description": "The object name.",
          "type": "string",
          "readOnly": true
        },
        "type": {
          "description": "The hierarchical type of the object.",
          "type": "string",
          "readOnly": true
        }
      },
      "x-ms-discriminator-value": "IotEdge"
    },
    "IoTAddonProperties": {
      "description": "IoT addon properties.",
      "required": [
        "ioTDeviceDetails",
        "ioTEdgeDeviceDetails"
      ],
      "type": "object",
      "properties": {
        "ioTDeviceDetails": {
          "$ref": "#/definitions/IoTDeviceInfo",
          "description": "IoT device metadata to which appliance needs to be connected."
        },
        "ioTEdgeDeviceDetails": {
          "$ref": "#/definitions/IoTDeviceInfo",
          "description": "IoT edge device to which the IoT Addon needs to be configured."
        },
        "version": {
          "description": "Version of IoT running on the appliance.",
          "type": "string",
          "readOnly": true
        },
        "hostPlatform": {
          "description": "Host OS supported by the IoT addon.",
          "enum": [
            "Windows",
            "Linux"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "PlatformType",
            "modelAsString": true
          }
        },
        "hostPlatformType": {
          "description": "Platform where the runtime is hosted.",
          "enum": [
            "KubernetesCluster",
            "LinuxVM"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "HostPlatformType",
            "modelAsString": true
          }
        },
        "provisioningState": {
          "description": "Addon Provisioning State",
          "enum": [
            "Invalid",
            "Creating",
            "Created",
            "Updating",
            "Reconfiguring",
            "Failed",
            "Deleting"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "AddonState",
            "modelAsString": true
          }
        }
      }
    },
    "IoTDeviceInfo": {
      "description": "Metadata of IoT device/IoT Edge device to be configured.",
      "required": [
        "deviceId",
        "ioTHostHub"
      ],
      "type": "object",
      "properties": {
        "deviceId": {
          "description": "ID of the IoT device/edge device.",
          "type": "string"
        },
        "ioTHostHub": {
          "description": "Host name for the IoT hub associated to the device.",
          "type": "string"
        },
        "ioTHostHubId": {
          "description": "Id for the IoT hub associated to the device.",
          "type": "string"
        },
        "authentication": {
          "$ref": "#/definitions/Authentication",
          "description": "Encrypted IoT device/IoT edge device connection string."
        }
      }
    },
    "IoTEdgeAgentInfo": {
      "description": "IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified.",
      "required": [
        "imageName",
        "tag"
      ],
      "type": "object",
      "properties": {
        "imageName": {
          "description": "Name of the IoT edge agent image.",
          "type": "string"
        },
        "tag": {
          "description": "Image Tag.",
          "type": "string"
        },
        "imageRepository": {
          "$ref": "#/definitions/ImageRepositoryCredential",
          "description": "Image repository details."
        }
      }
    },
    "IoTRole": {
      "description": "Compute role.",
      "required": [
        "kind"
      ],
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/Role"
        }
      ],
      "properties": {
        "properties": {
          "$ref": "#/definitions/IoTRoleProperties",
          "description": "Properties specific to IoT role.",
          "x-ms-client-flatten": true
        },
        "id": {
          "description": "The path ID that uniquely identifies the object.",
          "type": "string",
          "readOnly": true
        },
        "name": {
          "description": "The object name.",
          "type": "string",
          "readOnly": true
        },
        "type": {
          "description": "The hierarchical type of the object.",
          "type": "string",
          "readOnly": true
        }
      },
      "x-ms-discriminator-value": "IOT"
    },
    "IoTRoleProperties": {
      "description": "IoT role properties.",
      "required": [
        "hostPlatform",
        "ioTDeviceDetails",
        "ioTEdgeDeviceDetails",
        "roleStatus"
      ],
      "type": "object",
      "properties": {
        "hostPlatform": {
          "description": "Host OS supported by the IoT role.",
          "enum": [
            "Windows",
            "Linux"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "PlatformType",
            "modelAsString": true
          }
        },
        "ioTDeviceDetails": {
          "$ref": "#/definitions/IoTDeviceInfo",
          "description": "IoT device metadata to which data box edge device needs to be connected."
        },
        "ioTEdgeDeviceDetails": {
          "$ref": "#/definitions/IoTDeviceInfo",
          "description": "IoT edge device to which the IoT role needs to be configured."
        },
        "shareMappings": {
          "description": "Mount points of shares in role(s).",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/MountPointMap"
          }
        },
        "ioTEdgeAgentInfo": {
          "$ref": "#/definitions/IoTEdgeAgentInfo",
          "description": "Iot edge agent details to download the agent and bootstrap iot runtime."
        },
        "hostPlatformType": {
          "description": "Platform where the Iot runtime is hosted.",
          "enum": [
            "KubernetesCluster",
            "LinuxVM"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "HostPlatformType",
            "modelAsString": true
          }
        },
        "computeResource": {
          "$ref": "#/definitions/ComputeResource",
          "description": "Resource allocation"
        },
        "roleStatus": {
          "description": "Role status.",
          "enum": [
            "Enabled",
            "Disabled"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "RoleStatus",
            "modelAsString": true
          }
        }
      }
    },
    "Ipv4Config": {
      "description": "Details related to the IPv4 address configuration.",
      "type": "object",
      "properties": {
        "ipAddress": {
          "description": "The IPv4 address of the network adapter.",
          "type": "string",
          "readOnly": true
        },
        "subnet": {
          "description": "The IPv4 subnet of the network adapter.",
          "type": "string",
          "readOnly": true
        },
        "gateway": {
          "description": "The IPv4 gateway of the network adapter.",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "Ipv6Config": {
      "description": "Details related to the IPv6 address configuration.",
      "type": "object",
      "properties": {
        "ipAddress": {
          "description": "The IPv6 address of the network adapter.",
          "type": "string",
          "readOnly": true
        },
        "prefixLength": {
          "format": "int32",
          "description": "The IPv6 prefix of the network adapter.",
          "type": "integer",
          "readOnly": true
        },
        "gateway": {
          "description": "The IPv6 gateway of the network adapter.",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "Job": {
      "description": "A device job.",
      "type": "object",
      "properties": {
        "id": {
          "description": "The path ID that uniquely identifies the object.",
          "type": "string",
          "readOnly": true
        },
        "name": {
          "description": "The name of the object.",
          "type": "string",
          "readOnly": true
        },
        "type": {
          "description": "The hierarchical type of the object.",
          "type": "string",
          "readOnly": true
        },
        "status": {
          "description": "The current status of the job.",
          "enum": [
            "Invalid",
            "Running",
            "Succeeded",
            "Failed",
            "Canceled",
            "Paused",
            "Scheduled"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "JobStatus",
            "modelAsString": true
          }
        },
        "startTime": {
          "format": "date-time",
          "description": "The UTC date and time at which the job started.",
          "type": "string",
          "readOnly": true
        },
        "endTime": {
          "format": "date-time",
          "description": "The UTC date and time at which the job completed.",
          "type": "string",
          "readOnly": true
        },
        "percentComplete": {
          "format": "int32",
          "description": "The percentage of the job that is complete.",
          "type": "integer",
          "readOnly": true
        },
        "error": {
          "$ref": "#/definitions/JobErrorDetails",
          "description": "The error details.",
          "readOnly": true
        },
        "properties": {
          "$ref": "#/definitions/JobProperties",
          "description": "The properties of the job.",
          "readOnly": true,
          "x-ms-client-flatten": true
        }
      }
    },
    "JobErrorDetails": {
      "description": "The job error information containing the list of job errors.",
      "type": "object",
      "properties": {
        "errorDetails": {
          "description": "The error details.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/JobErrorItem"
          },
          "readOnly": true
        },
        "code": {
          "description": "The code intended for programmatic access.",
          "type": "string",
          "readOnly": true
        },
        "message": {
          "description": "The message that describes the error in detail.",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "JobErrorItem": {
      "description": "The job error items.",
      "type": "object",
      "properties": {
        "recommendations": {
          "description": "The recommended actions.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "type": "string"
          },
          "readOnly": true
        },
        "code": {
          "description": "The code intended for programmatic access.",
          "type": "string",
          "readOnly": true
        },
        "message": {
          "description": "The message that describes the error in detail.",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "JobProperties": {
      "description": "The properties for the job.",
      "type": "object",
      "properties": {
        "jobType": {
          "description": "The type of the job.",
          "enum": [
            "Invalid",
            "ScanForUpdates",
            "DownloadUpdates",
            "InstallUpdates",
            "RefreshShare",
            "RefreshContainer",
            "Backup",
            "Restore",
            "TriggerSupportPackage"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "JobType",
            "modelAsString": true
          }
        },
        "currentStage": {
          "description": "Current stage of the update operation.",
          "enum": [
            "Unknown",
            "Initial",
            "ScanStarted",
            "ScanComplete",
            "ScanFailed",
            "DownloadStarted",
            "DownloadComplete",
            "DownloadFailed",
            "InstallStarted",
            "InstallComplete",
            "InstallFailed",
            "RebootInitiated",
            "Success",
            "Failure",
            "RescanStarted",
            "RescanComplete",
            "RescanFailed"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "UpdateOperationStage",
            "modelAsString": true
          }
        },
        "downloadProgress": {
          "$ref": "#/definitions/UpdateDownloadProgress",
          "description": "The download progress.",
          "readOnly": true
        },
        "installProgress": {
          "$ref": "#/definitions/UpdateInstallProgress",
          "description": "The install progress.",
          "readOnly": true
        },
        "totalRefreshErrors": {
          "format": "int32",
          "description": "Total number of errors encountered during the refresh process.",
          "type": "integer",
          "readOnly": true
        },
        "errorManifestFile": {
          "description": "Local share/remote container relative path to the error manifest file of the refresh.",
          "type": "string",
          "readOnly": true
        },
        "refreshedEntityId": {
          "description": "ARM ID of the entity that was refreshed.",
          "type": "string",
          "readOnly": true
        },
        "folder": {
          "description": "If only subfolders need to be refreshed, then the subfolder path inside the share or container. (The path is empty if there are no subfolders.)",
          "type": "string"
        }
      }
    },
    "KubernetesClusterInfo": {
      "description": "Kubernetes cluster configuration",
      "required": [
        "version"
      ],
      "type": "object",
      "properties": {
        "etcdInfo": {
          "$ref": "#/definitions/EtcdInfo",
          "description": "Etcd configuration",
          "readOnly": true
        },
        "nodes": {
          "description": "Kubernetes cluster nodes",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/NodeInfo"
          },
          "readOnly": true
        },
        "version": {
          "description": "Kubernetes cluster version",
          "type": "string"
        }
      }
    },
    "KubernetesIPConfiguration": {
      "description": "Kubernetes node IP configuration",
      "type": "object",
      "properties": {
        "port": {
          "description": "Port of the Kubernetes node.",
          "type": "string",
          "readOnly": true
        },
        "ipAddress": {
          "description": "IP address of the Kubernetes node.",
          "type": "string"
        }
      }
    },
    "KubernetesRole": {
      "description": "Kubernetes role.",
      "required": [
        "kind"
      ],
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/Role"
        }
      ],
      "properties": {
        "properties": {
          "$ref": "#/definitions/KubernetesRoleProperties",
          "description": "Properties specific to Kubernetes role.",
          "x-ms-client-flatten": true
        },
        "id": {
          "description": "The path ID that uniquely identifies the object.",
          "type": "string",
          "readOnly": true
        },
        "name": {
          "description": "The object name.",
          "type": "string",
          "readOnly": true
        },
        "type": {
          "description": "The hierarchical type of the object.",
          "type": "string",
          "readOnly": true
        }
      },
      "x-ms-discriminator-value": "Kubernetes"
    },
    "KubernetesRoleCompute": {
      "description": "Kubernetes role compute resource",
      "required": [
        "vmProfile"
      ],
      "type": "object",
      "properties": {
        "vmProfile": {
          "description": "VM profile",
          "type": "string"
        },
        "memoryInBytes": {
          "format": "int64",
          "description": "Memory in bytes",
          "type": "integer",
          "readOnly": true
        },
        "processorCount": {
          "format": "int32",
          "description": "Processor count",
          "type": "integer",
          "readOnly": true
        }
      }
    },
    "KubernetesRoleNetwork": {
      "description": "Kubernetes role network resource",
      "type": "object",
      "properties": {
        "cniConfig": {
          "$ref": "#/definitions/CniConfig",
          "description": "Cni configuration",
          "readOnly": true
        },
        "loadBalancerConfig": {
          "$ref": "#/definitions/LoadBalancerConfig",
          "description": "Load balancer configuration",
          "readOnly": true
        }
      }
    },
    "KubernetesRoleProperties": {
      "description": "Kubernetes role properties.",
      "required": [
        "hostPlatform",
        "kubernetesClusterInfo",
        "kubernetesRoleResources",
        "roleStatus"
      ],
      "type": "object",
      "properties": {
        "hostPlatform": {
          "description": "Host OS supported by the Kubernetes role.",
          "enum": [
            "Windows",
            "Linux"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "PlatformType",
            "modelAsString": true
          }
        },
        "provisioningState": {
          "description": "State of Kubernetes deployment",
          "enum": [
            "Invalid",
            "Creating",
            "Created",
            "Updating",
            "Reconfiguring",
            "Failed",
            "Deleting"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "KubernetesState",
            "modelAsString": true
          }
        },
        "hostPlatformType": {
          "description": "Platform where the runtime is hosted.",
          "enum": [
            "KubernetesCluster",
            "LinuxVM"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "HostPlatformType",
            "modelAsString": true
          }
        },
        "kubernetesClusterInfo": {
          "$ref": "#/definitions/KubernetesClusterInfo",
          "description": "Kubernetes cluster configuration"
        },
        "kubernetesRoleResources": {
          "$ref": "#/definitions/KubernetesRoleResources",
          "description": "Kubernetes role resources"
        },
        "roleStatus": {
          "description": "Role status.",
          "enum": [
            "Enabled",
            "Disabled"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "RoleStatus",
            "modelAsString": true
          }
        }
      }
    },
    "KubernetesRoleResources": {
      "description": "Kubernetes role resources",
      "required": [
        "compute"
      ],
      "type": "object",
      "properties": {
        "storage": {
          "$ref": "#/definitions/KubernetesRoleStorage",
          "description": "Kubernetes role storage resource"
        },
        "compute": {
          "$ref": "#/definitions/KubernetesRoleCompute",
          "description": "Kubernetes role compute resource"
        },
        "network": {
          "$ref": "#/definitions/KubernetesRoleNetwork",
          "description": "Kubernetes role network resource",
          "readOnly": true
        }
      }
    },
    "KubernetesRoleStorage": {
      "description": "Kubernetes role storage resource",
      "type": "object",
      "properties": {
        "storageClasses": {
          "description": "Kubernetes storage class info.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/KubernetesRoleStorageClassInfo"
          },
          "readOnly": true
        },
        "endpoints": {
          "description": "Mount points of shares in role(s).",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/MountPointMap"
          }
        }
      }
    },
    "KubernetesRoleStorageClassInfo": {
      "description": "Kubernetes storage class info.",
      "type": "object",
      "properties": {
        "name": {
          "description": "Storage class name.",
          "type": "string",
          "readOnly": true
        },
        "type": {
          "description": "Storage class type.",
          "type": "string",
          "readOnly": true
        },
        "posixCompliant": {
          "description": "If provisioned storage is posix compliant.",
          "enum": [
            "Invalid",
            "Enabled",
            "Disabled"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "PosixComplianceStatus",
            "modelAsString": true
          }
        }
      }
    },
    "LoadBalancerConfig": {
      "description": "Load balancer configuration",
      "type": "object",
      "properties": {
        "type": {
          "description": "Load balancer type",
          "type": "string",
          "readOnly": true
        },
        "version": {
          "description": "Load balancer version",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "MECRole": {
      "description": "MEC role.",
      "required": [
        "kind"
      ],
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/Role"
        }
      ],
      "properties": {
        "properties": {
          "$ref": "#/definitions/MECRoleProperties",
          "description": "Properties specific to MEC role.",
          "x-ms-client-flatten": true
        },
        "id": {
          "description": "The path ID that uniquely identifies the object.",
          "type": "string",
          "readOnly": true
        },
        "name": {
          "description": "The object name.",
          "type": "string",
          "readOnly": true
        },
        "type": {
          "description": "The hierarchical type of the object.",
          "type": "string",
          "readOnly": true
        }
      },
      "x-ms-discriminator-value": "MEC"
    },
    "MECRoleProperties": {
      "description": "MEC role properties.",
      "required": [
        "roleStatus"
      ],
      "type": "object",
      "properties": {
        "connectionString": {
          "$ref": "#/definitions/AsymmetricEncryptedSecret",
          "description": "Activation key of the MEC."
        },
        "roleStatus": {
          "description": "Role status.",
          "enum": [
            "Enabled",
            "Disabled"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "RoleStatus",
            "modelAsString": true
          }
        }
      }
    },
    "MetricConfiguration": {
      "description": "Metric configuration.",
      "required": [
        "resourceId",
        "counterSets"
      ],
      "type": "object",
      "properties": {
        "resourceId": {
          "description": "The Resource ID on which the metrics should be pushed.",
          "type": "string"
        },
        "mdmAccount": {
          "description": "The MDM account to which the counters should be pushed.",
          "type": "string"
        },
        "metricNameSpace": {
          "description": "The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified",
          "type": "string"
        },
        "counterSets": {
          "description": "Host name for the IoT hub associated to the device.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/MetricCounterSet"
          }
        }
      }
    },
    "MetricCounter": {
      "description": "The metric counter",
      "required": [
        "name"
      ],
      "type": "object",
      "properties": {
        "name": {
          "description": "The counter name.",
          "type": "string"
        },
        "instance": {
          "description": "The instance from which counter should be collected.",
          "type": "string"
        },
        "dimensionFilter": {
          "description": "The dimension filter.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/MetricDimension"
          }
        },
        "additionalDimensions": {
          "description": "The additional dimensions to be added to metric.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/MetricDimension"
          }
        }
      }
    },
    "MetricCounterSet": {
      "description": "The metric counter set",
      "required": [
        "counters"
      ],
      "type": "object",
      "properties": {
        "counters": {
          "description": "The counters that should be collected in this set.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/MetricCounter"
          }
        }
      }
    },
    "MetricDimension": {
      "description": "The metric dimension",
      "required": [
        "sourceType",
        "sourceName"
      ],
      "type": "object",
      "properties": {
        "sourceType": {
          "description": "The dimension type.",
          "type": "string"
        },
        "sourceName": {
          "description": "The dimension value.",
          "type": "string"
        }
      }
    },
    "MetricDimension_V1": {
      "description": "Metric Dimension v1.",
      "type": "object",
      "properties": {
        "name": {
          "description": "Name of the metrics dimension.",
          "type": "string"
        },
        "displayName": {
          "description": "Display name of the metrics dimension.",
          "type": "string"
        },
        "toBeExportedForShoebox": {
          "description": "To be exported to shoe box.",
          "type": "boolean"
        }
      }
    },
    "MetricSpecification_V1": {
      "description": "Metric specification version 1.",
      "type": "object",
      "properties": {
        "name": {
          "description": "Name of the metric.",
          "type": "string"
        },
        "displayName": {
          "description": "Display name of the metric.",
          "type": "string"
        },
        "displayDescription": {
          "description": "Description of the metric to be displayed.",
          "type": "string"
        },
        "unit": {
          "description": "Metric units.",
          "enum": [
            "NotSpecified",
            "Percent",
            "Count",
            "Seconds",
            "Milliseconds",
            "Bytes",
            "BytesPerSecond",
            "CountPerSecond"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "MetricUnit",
            "modelAsString": true
          }
        },
        "aggregationType": {
          "description": "Metric aggregation type.",
          "enum": [
            "NotSpecified",
            "None",
            "Average",
            "Minimum",
            "Maximum",
            "Total",
            "Count"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "MetricAggregationType",
            "modelAsString": true
          }
        },
        "dimensions": {
          "description": "Metric dimensions, other than default dimension which is resource.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/MetricDimension_V1"
          }
        },
        "fillGapWithZero": {
          "description": "Set true to fill the gaps with zero.",
          "type": "boolean"
        },
        "category": {
          "description": "Metric category.",
          "enum": [
            "Capacity",
            "Transaction"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "MetricCategory",
            "modelAsString": true
          }
        },
        "resourceIdDimensionNameOverride": {
          "description": "Resource name override.",
          "type": "string"
        },
        "supportedTimeGrainTypes": {
          "description": "Support granularity of metrics.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "enum": [
              "PT1M",
              "PT5M",
              "PT15M",
              "PT30M",
              "PT1H",
              "PT6H",
              "PT12H",
              "PT1D"
            ],
            "type": "string",
            "x-ms-enum": {
              "name": "TimeGrain",
              "modelAsString": true
            }
          }
        },
        "supportedAggregationTypes": {
          "description": "Support metric aggregation type.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "enum": [
              "NotSpecified",
              "None",
              "Average",
              "Minimum",
              "Maximum",
              "Total",
              "Count"
            ],
            "type": "string",
            "x-ms-enum": {
              "name": "MetricAggregationType",
              "modelAsString": true
            }
          }
        }
      }
    },
    "MonitoringMetricConfiguration": {
      "description": "The metric setting details for the role",
      "required": [
        "properties"
      ],
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/ARMBaseModel"
        }
      ],
      "properties": {
        "properties": {
          "$ref": "#/definitions/MonitoringMetricConfigurationProperties",
          "description": "The metric setting properties.",
          "x-ms-client-flatten": true
        }
      }
    },
    "MonitoringMetricConfigurationList": {
      "description": "Collection of metric configurations.",
      "type": "object",
      "properties": {
        "value": {
          "description": "The list of metric configurations.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/MonitoringMetricConfiguration"
          },
          "readOnly": true
        },
        "nextLink": {
          "description": "Link to the next set of results.",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "MonitoringMetricConfigurationProperties": {
      "description": "Metrics properties",
      "required": [
        "metricConfigurations"
      ],
      "type": "object",
      "properties": {
        "metricConfigurations": {
          "description": "The metrics configuration details",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/MetricConfiguration"
          }
        }
      }
    },
    "MountPointMap": {
      "description": "The share mount point.",
      "required": [
        "shareId"
      ],
      "type": "object",
      "properties": {
        "shareId": {
          "description": "ID of the share mounted to the role VM.",
          "type": "string"
        },
        "roleId": {
          "description": "ID of the role to which share is mounted.",
          "type": "string",
          "readOnly": true
        },
        "mountPoint": {
          "description": "Mount point for the share.",
          "type": "string",
          "readOnly": true
        },
        "mountType": {
          "description": "Mounting type.",
          "enum": [
            "Volume",
            "HostPath"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "MountType",
            "modelAsString": true
          }
        },
        "roleType": {
          "description": "Role type.",
          "enum": [
            "IOT",
            "ASA",
            "Functions",
            "Cognitive",
            "MEC",
            "CloudEdgeManagement",
            "Kubernetes"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "RoleTypes",
            "modelAsString": true
          }
        }
      }
    },
    "NetworkAdapter": {
      "description": "Represents the networkAdapter on a device.",
      "type": "object",
      "properties": {
        "adapterId": {
          "description": "Instance ID of network adapter.",
          "type": "string",
          "readOnly": true
        },
        "adapterPosition": {
          "$ref": "#/definitions/NetworkAdapterPosition",
          "description": "Hardware position of network adapter.",
          "readOnly": true
        },
        "index": {
          "format": "int32",
          "description": "Logical index of the adapter.",
          "type": "integer",
          "readOnly": true
        },
        "nodeId": {
          "description": "Node ID of the network adapter.",
          "type": "string",
          "readOnly": true
        },
        "networkAdapterName": {
          "description": "Network adapter name.",
          "type": "string",
          "readOnly": true
        },
        "label": {
          "description": "Hardware label for the adapter.",
          "type": "string",
          "readOnly": true
        },
        "macAddress": {
          "description": "MAC address.",
          "type": "string",
          "readOnly": true
        },
        "linkSpeed": {
          "format": "int64",
          "description": "Link speed.",
          "type": "integer",
          "readOnly": true
        },
        "status": {
          "description": "Value indicating whether this adapter is valid.",
          "enum": [
            "Inactive",
            "Active"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "NetworkAdapterStatus",
            "modelAsString": true
          }
        },
        "rdmaStatus": {
          "description": "Value indicating whether this adapter is RDMA capable.",
          "enum": [
            "Incapable",
            "Capable"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "NetworkAdapterRDMAStatus",
            "modelAsString": true
          }
        },
        "dhcpStatus": {
          "description": "Value indicating whether this adapter has DHCP enabled.",
          "enum": [
            "Disabled",
            "Enabled"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "NetworkAdapterDHCPStatus",
            "modelAsString": true
          }
        },
        "ipv4Configuration": {
          "$ref": "#/definitions/Ipv4Config",
          "description": "The IPv4 configuration of the network adapter.",
          "readOnly": true
        },
        "ipv6Configuration": {
          "$ref": "#/definitions/Ipv6Config",
          "description": "The IPv6 configuration of the network adapter.",
          "readOnly": true
        },
        "ipv6LinkLocalAddress": {
          "description": "The IPv6 local address.",
          "type": "string",
          "readOnly": true
        },
        "dnsServers": {
          "description": "The list of DNS Servers of the device.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "type": "string"
          },
          "readOnly": true
        }
      }
    },
    "NetworkAdapterPosition": {
      "description": "The network adapter position.",
      "type": "object",
      "properties": {
        "networkGroup": {
          "description": "The network group.",
          "enum": [
            "None",
            "NonRDMA",
            "RDMA"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "NetworkGroup",
            "modelAsString": true
          }
        },
        "port": {
          "format": "int32",
          "description": "The port.",
          "type": "integer",
          "readOnly": true
        }
      }
    },
    "NetworkSettings": {
      "description": "The network settings of a device.",
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/ARMBaseModel"
        }
      ],
      "properties": {
        "properties": {
          "$ref": "#/definitions/NetworkSettingsProperties",
          "description": "The properties of network settings of a device.",
          "readOnly": true,
          "x-ms-client-flatten": true
        }
      }
    },
    "NetworkSettingsProperties": {
      "description": "The properties of network settings.",
      "type": "object",
      "properties": {
        "networkAdapters": {
          "description": "The network adapter list on the device.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/NetworkAdapter"
          },
          "readOnly": true
        }
      }
    },
    "Node": {
      "description": "Represents a single node in a Data box Edge/Gateway device\r\nGateway devices, standalone Edge devices and a single node cluster Edge device will all have 1 node\r\nMulti-node Edge devices will have more than 1 nodes",
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/ARMBaseModel"
        }
      ],
      "properties": {
        "properties": {
          "$ref": "#/definitions/NodeProperties",
          "description": "The properties of the node",
          "readOnly": true,
          "x-ms-client-flatten": true
        }
      }
    },
    "NodeInfo": {
      "description": "Kubernetes node info",
      "type": "object",
      "properties": {
        "name": {
          "description": "Node name.",
          "type": "string",
          "readOnly": true
        },
        "type": {
          "description": "Node type - Master/Worker",
          "enum": [
            "Invalid",
            "Master",
            "Worker"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "KubernetesNodeType",
            "modelAsString": true
          }
        },
        "ipConfiguration": {
          "description": "IP Configuration of the Kubernetes node.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/KubernetesIPConfiguration"
          }
        }
      }
    },
    "NodeList": {
      "description": "Collection of Nodes.",
      "type": "object",
      "properties": {
        "value": {
          "description": "The list of Nodes.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/Node"
          },
          "readOnly": true
        },
        "nextLink": {
          "description": "Link to the next set of results.",
          "type": "string"
        }
      }
    },
    "NodeProperties": {
      "description": "This class represents the nodes in a highly available cluster",
      "type": "object",
      "properties": {
        "nodeStatus": {
          "description": "The current status of the individual node",
          "enum": [
            "Unknown",
            "Up",
            "Down",
            "Rebooting",
            "ShuttingDown"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "NodeStatus",
            "modelAsString": true
          }
        },
        "nodeChassisSerialNumber": {
          "description": "Serial number of the Chassis",
          "type": "string",
          "readOnly": true
        },
        "nodeSerialNumber": {
          "description": "Serial number of the individual node",
          "type": "string",
          "readOnly": true
        },
        "nodeDisplayName": {
          "description": "Display Name of the individual node",
          "type": "string",
          "readOnly": true
        },
        "nodeFriendlySoftwareVersion": {
          "description": "Friendly software version name that is currently installed on the node",
          "type": "string",
          "readOnly": true
        },
        "nodeHcsVersion": {
          "description": "HCS version that is currently installed on the node",
          "type": "string",
          "readOnly": true
        },
        "nodeInstanceId": {
          "description": "Guid instance id of the node",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "Operation": {
      "description": "Operations.",
      "type": "object",
      "properties": {
        "name": {
          "description": "Name of the operation.",
          "type": "string"
        },
        "display": {
          "$ref": "#/definitions/OperationDisplay",
          "description": "Properties displayed for the operation."
        },
        "origin": {
          "description": "Origin of the operation.",
          "type": "string"
        },
        "isDataAction": {
          "description": "Indicates whether the operation is a data action",
          "type": "boolean"
        },
        "properties": {
          "$ref": "#/definitions/OperationProperties",
          "description": "Operation properties.",
          "x-ms-client-flatten": true
        }
      }
    },
    "OperationDisplay": {
      "description": "Operation display properties.",
      "type": "object",
      "properties": {
        "provider": {
          "description": "Provider name.",
          "type": "string"
        },
        "resource": {
          "description": "The type of resource in which the operation is performed.",
          "type": "string"
        },
        "operation": {
          "description": "Operation to be performed on the resource.",
          "type": "string"
        },
        "description": {
          "description": "Description of the operation to be performed.",
          "type": "string"
        }
      }
    },
    "OperationProperties": {
      "description": "Operation properties.",
      "type": "object",
      "properties": {
        "serviceSpecification": {
          "$ref": "#/definitions/ServiceSpecification",
          "description": "Service specification."
        }
      }
    },
    "OperationsList": {
      "description": "The list of operations used for the discovery of available provider operations.",
      "required": [
        "value"
      ],
      "type": "object",
      "properties": {
        "value": {
          "description": "The value.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/Operation"
          }
        },
        "nextLink": {
          "description": "Link to the next set of results.",
          "type": "string"
        }
      }
    },
    "Order": {
      "description": "The order details.",
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/ARMBaseModel"
        }
      ],
      "properties": {
        "properties": {
          "$ref": "#/definitions/OrderProperties",
          "description": "The order properties.",
          "x-ms-client-flatten": true
        }
      }
    },
    "OrderList": {
      "description": "List of order entities.",
      "type": "object",
      "properties": {
        "value": {
          "description": "The list of orders.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/Order"
          },
          "readOnly": true
        },
        "nextLink": {
          "description": "Link to the next set of results.",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "OrderProperties": {
      "description": "Order properties.",
      "required": [
        "contactInformation"
      ],
      "type": "object",
      "properties": {
        "contactInformation": {
          "$ref": "#/definitions/ContactDetails",
          "description": "The contact details."
        },
        "shippingAddress": {
          "$ref": "#/definitions/Address",
          "description": "The shipping address."
        },
        "currentStatus": {
          "$ref": "#/definitions/OrderStatus",
          "description": "Current status of the order."
        },
        "orderHistory": {
          "description": "List of status changes in the order.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/OrderStatus"
          },
          "readOnly": true
        },
        "serialNumber": {
          "description": "Serial number of the device.",
          "type": "string",
          "readOnly": true
        },
        "deliveryTrackingInfo": {
          "description": "Tracking information for the package delivered to the customer whether it has an original or a replacement device.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/TrackingInfo"
          },
          "readOnly": true
        },
        "returnTrackingInfo": {
          "description": "Tracking information for the package returned from the customer whether it has an original or a replacement device.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/TrackingInfo"
          },
          "readOnly": true
        },
        "shipmentType": {
          "description": "ShipmentType of the order",
          "enum": [
            "NotApplicable",
            "ShippedToCustomer",
            "SelfPickup"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "ShipmentType",
            "modelAsString": true
          }
        }
      }
    },
    "OrderStatus": {
      "description": "Represents a single status change.",
      "required": [
        "status"
      ],
      "type": "object",
      "properties": {
        "status": {
          "description": "Status of the order as per the allowed status types.",
          "enum": [
            "Untracked",
            "AwaitingFulfilment",
            "AwaitingPreparation",
            "AwaitingShipment",
            "Shipped",
            "Arriving",
            "Delivered",
            "ReplacementRequested",
            "LostDevice",
            "Declined",
            "ReturnInitiated",
            "AwaitingReturnShipment",
            "ShippedBack",
            "CollectedAtMicrosoft",
            "AwaitingPickup",
            "PickupCompleted",
            "AwaitingDrop"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "OrderState",
            "modelAsString": true
          }
        },
        "updateDateTime": {
          "format": "date-time",
          "description": "Time of status update.",
          "type": "string",
          "readOnly": true
        },
        "comments": {
          "description": "Comments related to this status change.",
          "type": "string"
        },
        "trackingInformation": {
          "$ref": "#/definitions/TrackingInfo",
          "description": "Tracking information related to the state in the ordering flow",
          "readOnly": true
        },
        "additionalOrderDetails": {
          "description": "Dictionary to hold generic information which is not stored\r\nby the already existing properties",
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "readOnly": true
        }
      }
    },
    "PeriodicTimerEventTrigger": {
      "description": "Trigger details.",
      "required": [
        "properties",
        "kind"
      ],
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/Trigger"
        }
      ],
      "properties": {
        "properties": {
          "$ref": "#/definitions/PeriodicTimerProperties",
          "description": "Periodic timer trigger properties.",
          "x-ms-client-flatten": true
        },
        "id": {
          "description": "The path ID that uniquely identifies the object.",
          "type": "string",
          "readOnly": true
        },
        "name": {
          "description": "The object name.",
          "type": "string",
          "readOnly": true
        },
        "type": {
          "description": "The hierarchical type of the object.",
          "type": "string",
          "readOnly": true
        }
      },
      "x-ms-discriminator-value": "PeriodicTimerEvent"
    },
    "PeriodicTimerProperties": {
      "description": "Periodic timer trigger properties.",
      "required": [
        "sourceInfo",
        "sinkInfo"
      ],
      "type": "object",
      "properties": {
        "sourceInfo": {
          "$ref": "#/definitions/PeriodicTimerSourceInfo",
          "description": "Periodic timer details."
        },
        "sinkInfo": {
          "$ref": "#/definitions/RoleSinkInfo",
          "description": "Role Sink information."
        },
        "customContextTag": {
          "description": "A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module.",
          "maxLength": 192,
          "type": "string"
        }
      }
    },
    "PeriodicTimerSourceInfo": {
      "description": "Periodic timer event source.",
      "required": [
        "startTime",
        "schedule"
      ],
      "type": "object",
      "properties": {
        "startTime": {
          "format": "date-time",
          "description": "The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time.",
          "type": "string"
        },
        "schedule": {
          "description": "Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds.",
          "type": "string"
        },
        "topic": {
          "description": "Topic where periodic events are published to IoT device.",
          "type": "string"
        }
      }
    },
    "RawCertificateData": {
      "description": "Raw Certificate Data.",
      "required": [
        "certificate"
      ],
      "type": "object",
      "properties": {
        "authenticationType": {
          "description": "The authentication type.",
          "enum": [
            "Invalid",
            "AzureActiveDirectory"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "AuthenticationType",
            "modelAsString": true
          }
        },
        "certificate": {
          "description": "The base64 encoded certificate raw data.",
          "type": "string"
        }
      }
    },
    "RefreshDetails": {
      "description": "Fields for tracking refresh job on the share or container.",
      "type": "object",
      "properties": {
        "inProgressRefreshJobId": {
          "description": "If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress.",
          "type": "string"
        },
        "lastCompletedRefreshJobTimeInUTC": {
          "format": "date-time",
          "description": "Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job.",
          "type": "string"
        },
        "errorManifestFile": {
          "description": "Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job.",
          "type": "string"
        },
        "lastJob": {
          "description": "Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job.",
          "type": "string"
        }
      }
    },
    "ResourceIdentity": {
      "description": "Msi identity details of the resource",
      "type": "object",
      "properties": {
        "type": {
          "description": "Identity type",
          "enum": [
            "None",
            "SystemAssigned",
            "UserAssigned"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "MsiIdentityType",
            "modelAsString": true
          }
        },
        "principalId": {
          "description": "Service Principal Id backing the Msi",
          "type": "string",
          "readOnly": true
        },
        "tenantId": {
          "description": "Home Tenant Id",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "ResourceMoveDetails": {
      "description": "Fields for tracking resource move",
      "type": "object",
      "properties": {
        "operationInProgress": {
          "description": "Denotes whether move operation is in progress",
          "enum": [
            "None",
            "ResourceMoveInProgress",
            "ResourceMoveFailed"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "ResourceMoveStatus",
            "modelAsString": true
          }
        },
        "operationInProgressLockTimeoutInUTC": {
          "format": "date-time",
          "description": "Denotes the timeout of the operation to finish",
          "type": "string"
        }
      }
    },
    "ResourceTypeSku": {
      "description": "Resource type Sku object",
      "type": "object",
      "properties": {
        "resourceType": {
          "description": "The resource type.",
          "type": "string",
          "readOnly": true
        },
        "skus": {
          "description": "The skus.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/SkuInformation"
          },
          "readOnly": true
        }
      }
    },
    "Role": {
      "description": "Compute role.",
      "required": [
        "kind"
      ],
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/ARMBaseModel"
        }
      ],
      "properties": {
        "kind": {
          "description": "Role type.",
          "enum": [
            "IOT",
            "ASA",
            "Functions",
            "Cognitive",
            "MEC",
            "CloudEdgeManagement",
            "Kubernetes"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "RoleTypes",
            "modelAsString": true
          }
        },
        "systemData": {
          "description": "Role configured on ASE resource",
          "$ref": "#/definitions/SystemData"
        }
      },
      "discriminator": "kind"
    },
    "RoleList": {
      "description": "Collection of all the roles on the Data Box Edge device.",
      "type": "object",
      "properties": {
        "value": {
          "description": "The Value.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/Role"
          },
          "readOnly": true
        },
        "nextLink": {
          "description": "Link to the next set of results.",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "RoleSinkInfo": {
      "description": "Compute role against which events will be raised.",
      "required": [
        "roleId"
      ],
      "type": "object",
      "properties": {
        "roleId": {
          "description": "Compute role ID.",
          "type": "string"
        }
      }
    },
    "SecuritySettings": {
      "description": "The security settings of a device.",
      "required": [
        "properties"
      ],
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/ARMBaseModel"
        }
      ],
      "properties": {
        "properties": {
          "$ref": "#/definitions/SecuritySettingsProperties",
          "description": "Properties of the security settings.",
          "x-ms-client-flatten": true
        }
      }
    },
    "SecuritySettingsProperties": {
      "description": "The properties of security settings.",
      "required": [
        "deviceAdminPassword"
      ],
      "type": "object",
      "properties": {
        "deviceAdminPassword": {
          "$ref": "#/definitions/AsymmetricEncryptedSecret",
          "description": "Device administrator password as an encrypted string (encrypted using RSA PKCS #1) is used to sign into the  local web UI of the device. The Actual password should have at least 8 characters that are a combination of  uppercase, lowercase, numeric, and special characters."
        }
      }
    },
    "ServiceSpecification": {
      "description": "Service specification.",
      "type": "object",
      "properties": {
        "metricSpecifications": {
          "description": "Metric specification as defined by shoebox.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/MetricSpecification_V1"
          }
        }
      }
    },
    "Share": {
      "description": "Represents a share on the  Data Box Edge/Gateway device.",
      "required": [
        "properties"
      ],
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/ARMBaseModel"
        }
      ],
      "properties": {
        "systemData": {
          "description": "Share on ASE device",
          "$ref": "#/definitions/SystemData"
        },
        "properties": {
          "$ref": "#/definitions/ShareProperties",
          "description": "The share properties.",
          "x-ms-client-flatten": true
        }
      }
    },
    "ShareAccessRight": {
      "description": "Specifies the mapping between this particular user and the type of access he has on shares on this device.",
      "required": [
        "shareId",
        "accessType"
      ],
      "type": "object",
      "properties": {
        "shareId": {
          "description": "The share ID.",
          "type": "string"
        },
        "accessType": {
          "description": "Type of access to be allowed on the share for this user.",
          "enum": [
            "Change",
            "Read",
            "Custom"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "ShareAccessType",
            "modelAsString": true
          }
        }
      }
    },
    "ShareList": {
      "description": "Collection of all the shares on the Data Box Edge/Gateway device.",
      "type": "object",
      "properties": {
        "value": {
          "description": "The list of shares.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/Share"
          },
          "readOnly": true
        },
        "nextLink": {
          "description": "Link to the next set of results.",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "ShareProperties": {
      "description": "The share properties.",
      "required": [
        "shareStatus",
        "monitoringStatus",
        "accessProtocol"
      ],
      "type": "object",
      "properties": {
        "description": {
          "description": "Description for the share.",
          "type": "string"
        },
        "shareStatus": {
          "description": "Current status of the share.",
          "enum": [
            "Offline",
            "Unknown",
            "OK",
            "Updating",
            "NeedsAttention"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "ShareStatus",
            "modelAsString": true
          }
        },
        "monitoringStatus": {
          "description": "Current monitoring status of the share.",
          "enum": [
            "Enabled",
            "Disabled"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "MonitoringStatus",
            "modelAsString": true
          }
        },
        "azureContainerInfo": {
          "$ref": "#/definitions/AzureContainerInfo",
          "description": "Azure container mapping for the share."
        },
        "accessProtocol": {
          "description": "Access protocol to be used by the share.",
          "enum": [
            "SMB",
            "NFS"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "ShareAccessProtocol",
            "modelAsString": true
          }
        },
        "userAccessRights": {
          "description": "Mapping of users and corresponding access rights on the share (required for SMB protocol).",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/UserAccessRight"
          }
        },
        "clientAccessRights": {
          "description": "List of IP addresses and corresponding access rights on the share(required for NFS protocol).",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/ClientAccessRight"
          }
        },
        "refreshDetails": {
          "$ref": "#/definitions/RefreshDetails",
          "description": "Details of the refresh job on this share."
        },
        "shareMappings": {
          "description": "Share mount point to the role.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/MountPointMap"
          },
          "readOnly": true
        },
        "dataPolicy": {
          "description": "Data policy of the share.",
          "enum": [
            "Cloud",
            "Local"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "DataPolicy",
            "modelAsString": true
          }
        }
      }
    },
    "Sku": {
      "description": "The SKU type.",
      "type": "object",
      "properties": {
        "name": {
          "description": "SKU name.",
          "enum": [
            "Gateway",
            "Edge",
            "TEA_1Node",
            "TEA_1Node_UPS",
            "TEA_1Node_Heater",
            "TEA_1Node_UPS_Heater",
            "TEA_4Node_Heater",
            "TEA_4Node_UPS_Heater",
            "TMA",
            "TDC",
            "TCA_Small",
            "GPU",
            "TCA_Large",
            "EdgeP_Base",
            "EdgeP_High",
            "EdgePR_Base",
            "EdgePR_Base_UPS",
            "EdgeMR_Mini",
            "RCA_Small",
            "RCA_Large",
            "RDC"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "SkuName",
            "modelAsString": true
          }
        },
        "tier": {
          "description": "The SKU tier. This is based on the SKU name.",
          "enum": [
            "Standard"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "SkuTier",
            "modelAsString": true
          }
        }
      }
    },
    "SkuCost": {
      "description": "The metadata for retrieving price info.",
      "type": "object",
      "properties": {
        "meterId": {
          "description": "Used for querying price from commerce.",
          "type": "string",
          "readOnly": true
        },
        "quantity": {
          "format": "int64",
          "description": "The cost quantity.",
          "type": "integer",
          "readOnly": true
        },
        "extendedUnit": {
          "description": "The extended unit.",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "SkuInformation": {
      "description": "Sku information",
      "type": "object",
      "properties": {
        "name": {
          "description": "The sku name.",
          "type": "string",
          "readOnly": true
        },
        "tier": {
          "description": "The sku tier.",
          "type": "string",
          "readOnly": true
        },
        "kind": {
          "description": "The sku kind.",
          "type": "string",
          "readOnly": true
        },
        "family": {
          "description": "The Sku family.",
          "type": "string",
          "readOnly": true
        },
        "costs": {
          "description": "The pricing info of the Sku.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/SkuCost"
          },
          "readOnly": true
        },
        "locations": {
          "description": "The locations where Sku is available.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "type": "string"
          },
          "readOnly": true
        },
        "locationInfo": {
          "description": "The locations where Sku is available with zones and sites info",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/SkuLocationInfo"
          },
          "readOnly": true
        },
        "requiredQuotaIds": {
          "description": "The required quotaIds for the sku to be available.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "type": "string"
          },
          "readOnly": true
        },
        "requiredFeatures": {
          "description": "The required features for the sku to be available.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "type": "string"
          },
          "readOnly": true
        }
      }
    },
    "SkuInformationList": {
      "description": "List of SKU Information objects",
      "type": "object",
      "properties": {
        "value": {
          "description": "List of ResourceTypeSku objects",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/ResourceTypeSku"
          },
          "readOnly": true
        },
        "nextLink": {
          "description": "Links to the next set of results",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "SkuLocationInfo": {
      "description": "The location info.",
      "type": "object",
      "properties": {
        "location": {
          "description": "The location.",
          "type": "string",
          "readOnly": true
        },
        "zones": {
          "description": "The zones.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "type": "string"
          },
          "readOnly": true
        },
        "sites": {
          "description": "The sites.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "type": "string"
          },
          "readOnly": true
        }
      }
    },
    "StorageAccount": {
      "description": "Represents a Storage Account on the  Data Box Edge/Gateway device.",
      "required": [
        "properties"
      ],
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/ARMBaseModel"
        }
      ],
      "properties": {
        "systemData": {
          "description": "StorageAccount object on ASE device",
          "$ref": "#/definitions/SystemData"
        },
        "properties": {
          "$ref": "#/definitions/StorageAccountProperties",
          "description": "The Storage Account properties.",
          "x-ms-client-flatten": true
        }
      }
    },
    "StorageAccountCredential": {
      "description": "The storage account credential.",
      "required": [
        "properties"
      ],
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/ARMBaseModel"
        }
      ],
      "properties": {
        "systemData": {
          "description": "StorageAccountCredential object",
          "$ref": "#/definitions/SystemData"
        },
        "properties": {
          "$ref": "#/definitions/StorageAccountCredentialProperties",
          "description": "The storage account credential properties.",
          "x-ms-client-flatten": true
        }
      }
    },
    "StorageAccountCredentialList": {
      "description": "The collection of storage account credentials.",
      "type": "object",
      "properties": {
        "value": {
          "description": "The value.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/StorageAccountCredential"
          },
          "readOnly": true
        },
        "nextLink": {
          "description": "Link to the next set of results.",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "StorageAccountCredentialProperties": {
      "description": "The storage account credential properties.",
      "required": [
        "alias",
        "sslStatus",
        "accountType"
      ],
      "type": "object",
      "properties": {
        "alias": {
          "description": "Alias for the storage account.",
          "type": "string"
        },
        "userName": {
          "description": "Username for the storage account.",
          "type": "string"
        },
        "accountKey": {
          "$ref": "#/definitions/AsymmetricEncryptedSecret",
          "description": "Encrypted storage key."
        },
        "connectionString": {
          "description": "Connection string for the storage account. Use this string if username and account key are not specified.",
          "type": "string"
        },
        "sslStatus": {
          "description": "Signifies whether SSL needs to be enabled or not.",
          "enum": [
            "Enabled",
            "Disabled"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "SSLStatus",
            "modelAsString": true
          }
        },
        "blobDomainName": {
          "description": "Blob end point for private clouds.",
          "type": "string"
        },
        "accountType": {
          "description": "Type of storage accessed on the storage account.",
          "enum": [
            "GeneralPurposeStorage",
            "BlobStorage"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "AccountType",
            "modelAsString": true
          }
        },
        "storageAccountId": {
          "description": "Id of the storage account.",
          "type": "string"
        }
      }
    },
    "StorageAccountList": {
      "description": "Collection of all the Storage Accounts on the Data Box Edge/Gateway device.",
      "type": "object",
      "properties": {
        "value": {
          "description": "The list of storageAccounts.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/StorageAccount"
          },
          "readOnly": true
        },
        "nextLink": {
          "description": "Link to the next set of results.",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "StorageAccountProperties": {
      "description": "The storage account properties.",
      "required": [
        "dataPolicy"
      ],
      "type": "object",
      "properties": {
        "description": {
          "description": "Description for the storage Account.",
          "type": "string"
        },
        "storageAccountStatus": {
          "description": "Current status of the storage account",
          "enum": [
            "OK",
            "Offline",
            "Unknown",
            "Updating",
            "NeedsAttention"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "StorageAccountStatus",
            "modelAsString": true
          }
        },
        "dataPolicy": {
          "description": "Data policy of the storage Account.",
          "enum": [
            "Cloud",
            "Local"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "DataPolicy",
            "modelAsString": true
          }
        },
        "storageAccountCredentialId": {
          "description": "Storage Account Credential Id",
          "type": "string"
        },
        "blobEndpoint": {
          "description": "BlobEndpoint of Storage Account",
          "type": "string",
          "readOnly": true
        },
        "containerCount": {
          "format": "int32",
          "description": "The Container Count. Present only for Storage Accounts with DataPolicy set to Cloud.",
          "type": "integer",
          "readOnly": true
        }
      }
    },
    "SubscriptionProperties": {
      "type": "object",
      "properties": {
        "tenantId": {
          "type": "string"
        },
        "locationPlacementId": {
          "type": "string"
        },
        "quotaId": {
          "type": "string"
        },
        "serializedDetails": {
          "type": "string"
        },
        "registeredFeatures": {
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/SubscriptionRegisteredFeatures"
          }
        }
      }
    },
    "SubscriptionRegisteredFeatures": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "state": {
          "type": "string"
        }
      }
    },
    "SymmetricKey": {
      "description": "Symmetric key for authentication.",
      "type": "object",
      "properties": {
        "connectionString": {
          "$ref": "#/definitions/AsymmetricEncryptedSecret",
          "description": "Connection string based on the symmetric key."
        }
      }
    },
    "SystemData": {
      "description": "Metadata pertaining to creation and last modification of the resource.",
      "type": "object",
      "readOnly": true,
      "properties": {
        "createdBy": {
          "type": "string",
          "description": "The identity that created the resource."
        },
        "createdByType": {
          "type": "string",
          "description": "The type of identity that created the resource.",
          "enum": [
            "User",
            "Application",
            "ManagedIdentity",
            "Key"
          ],
          "x-ms-enum": {
            "name": "createdByType",
            "modelAsString": true
          }
        },
        "createdAt": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp of resource creation (UTC)."
        },
        "lastModifiedBy": {
          "type": "string",
          "description": "The identity that last modified the resource."
        },
        "lastModifiedByType": {
          "type": "string",
          "description": "The type of identity that last modified the resource.",
          "enum": [
            "User",
            "Application",
            "ManagedIdentity",
            "Key"
          ],
          "x-ms-enum": {
            "name": "createdByType",
            "modelAsString": true
          }
        },
        "lastModifiedAt": {
          "type": "string",
          "format": "date-time",
          "description": "The type of identity that last modified the resource."
        }
      }
    },
    "TrackingInfo": {
      "description": "Tracking courier information.",
      "type": "object",
      "properties": {
        "serialNumber": {
          "description": "Serial number of the device being tracked.",
          "type": "string"
        },
        "carrierName": {
          "description": "Name of the carrier used in the delivery.",
          "type": "string"
        },
        "trackingId": {
          "description": "Tracking ID of the shipment.",
          "type": "string"
        },
        "trackingUrl": {
          "description": "Tracking URL of the shipment.",
          "type": "string"
        }
      }
    },
    "Trigger": {
      "description": "Trigger details.",
      "required": [
        "kind"
      ],
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/ARMBaseModel"
        }
      ],
      "properties": {
        "systemData": {
          "description": "Trigger in DataBoxEdge Resource",
          "$ref": "#/definitions/SystemData"
        },
        "kind": {
          "description": "Trigger Kind.",
          "enum": [
            "FileEvent",
            "PeriodicTimerEvent"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "TriggerEventType",
            "modelAsString": true
          }
        }
      },
      "discriminator": "kind"
    },
    "TriggerList": {
      "description": "Collection of all trigger on the data box edge device.",
      "type": "object",
      "properties": {
        "value": {
          "description": "The list of triggers.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/Trigger"
          },
          "readOnly": true
        },
        "nextLink": {
          "description": "Link to the next set of results.",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "UpdateDownloadProgress": {
      "description": "Details about the download progress of update.",
      "type": "object",
      "properties": {
        "downloadPhase": {
          "description": "The download phase.",
          "enum": [
            "Unknown",
            "Initializing",
            "Downloading",
            "Verifying"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "DownloadPhase",
            "modelAsString": true
          }
        },
        "percentComplete": {
          "format": "int32",
          "description": "Percentage of completion.",
          "type": "integer",
          "readOnly": true
        },
        "totalBytesToDownload": {
          "format": "double",
          "description": "Total bytes to download.",
          "type": "number",
          "readOnly": true
        },
        "totalBytesDownloaded": {
          "format": "double",
          "description": "Total bytes downloaded.",
          "type": "number",
          "readOnly": true
        },
        "numberOfUpdatesToDownload": {
          "format": "int32",
          "description": "Number of updates to download.",
          "type": "integer",
          "readOnly": true
        },
        "numberOfUpdatesDownloaded": {
          "format": "int32",
          "description": "Number of updates downloaded.",
          "type": "integer",
          "readOnly": true
        }
      }
    },
    "UpdateInstallProgress": {
      "description": "Progress details during installation of updates.",
      "type": "object",
      "properties": {
        "percentComplete": {
          "format": "int32",
          "description": "Percentage completed.",
          "type": "integer",
          "readOnly": true
        },
        "numberOfUpdatesToInstall": {
          "format": "int32",
          "description": "Number of updates to install.",
          "type": "integer",
          "readOnly": true
        },
        "numberOfUpdatesInstalled": {
          "format": "int32",
          "description": "Number of updates installed.",
          "type": "integer",
          "readOnly": true
        }
      }
    },
    "UpdateSummary": {
      "description": "Details about ongoing updates and availability of updates on the device.",
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/ARMBaseModel"
        }
      ],
      "properties": {
        "properties": {
          "$ref": "#/definitions/UpdateSummaryProperties",
          "description": "The device update information summary.",
          "x-ms-client-flatten": true
        }
      }
    },
    "UpdateSummaryProperties": {
      "description": "The device update information summary.",
      "type": "object",
      "properties": {
        "deviceVersionNumber": {
          "description": "The current version of the device in format: 1.2.17312.13.\",",
          "type": "string"
        },
        "friendlyDeviceVersionName": {
          "description": "The current version of the device in text format.",
          "type": "string"
        },
        "deviceLastScannedDateTime": {
          "format": "date-time",
          "description": "The last time when a scan was done on the device.",
          "type": "string"
        },
        "lastCompletedScanJobDateTime": {
          "format": "date-time",
          "description": "The time when the last scan job was completed (success/cancelled/failed) on the appliance.",
          "type": "string"
        },
        "lastCompletedDownloadJobDateTime": {
          "format": "date-time",
          "description": "The time when the last Download job was completed (success/cancelled/failed) on the appliance.",
          "type": "string",
          "readOnly": true
        },
        "lastCompletedInstallJobDateTime": {
          "format": "date-time",
          "description": "The time when the last Install job was completed (success/cancelled/failed) on the appliance.",
          "type": "string",
          "readOnly": true
        },
        "totalNumberOfUpdatesAvailable": {
          "format": "int32",
          "description": "The number of updates available for the current device version as per the last device scan.",
          "type": "integer",
          "readOnly": true
        },
        "totalNumberOfUpdatesPendingDownload": {
          "format": "int32",
          "description": "The total number of items pending download.",
          "type": "integer",
          "readOnly": true
        },
        "totalNumberOfUpdatesPendingInstall": {
          "format": "int32",
          "description": "The total number of items pending install.",
          "type": "integer",
          "readOnly": true
        },
        "rebootBehavior": {
          "description": "Indicates if updates are available and at least one of the updates needs a reboot.",
          "enum": [
            "NeverReboots",
            "RequiresReboot",
            "RequestReboot"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "InstallRebootBehavior",
            "modelAsString": true
          }
        },
        "ongoingUpdateOperation": {
          "description": "The current update operation.",
          "enum": [
            "None",
            "Scan",
            "Download",
            "Install"
          ],
          "type": "string",
          "readOnly": true,
          "x-ms-enum": {
            "name": "UpdateOperation",
            "modelAsString": true
          }
        },
        "inProgressDownloadJobId": {
          "description": "The job ID of the download job in progress.",
          "type": "string",
          "readOnly": true
        },
        "inProgressInstallJobId": {
          "description": "The job ID of the install job in progress.",
          "type": "string",
          "readOnly": true
        },
        "inProgressDownloadJobStartedDateTime": {
          "format": "date-time",
          "description": "The time when the currently running download (if any) started.",
          "type": "string",
          "readOnly": true
        },
        "inProgressInstallJobStartedDateTime": {
          "format": "date-time",
          "description": "The time when the currently running install (if any) started.",
          "type": "string",
          "readOnly": true
        },
        "updateTitles": {
          "description": "The list of updates available for install.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "type": "string"
          },
          "readOnly": true
        },
        "totalUpdateSizeInBytes": {
          "format": "double",
          "description": "The total size of updates available for download in bytes.",
          "type": "number",
          "readOnly": true
        }
      }
    },
    "UploadCertificateRequest": {
      "description": "The upload certificate request.",
      "required": [
        "properties"
      ],
      "type": "object",
      "properties": {
        "properties": {
          "$ref": "#/definitions/RawCertificateData",
          "description": "The Base 64 encoded certificate raw data.",
          "x-ms-client-flatten": true
        }
      }
    },
    "UploadCertificateResponse": {
      "description": "The upload registration certificate response.",
      "type": "object",
      "properties": {
        "authType": {
          "description": "Specifies authentication type.",
          "enum": [
            "Invalid",
            "AzureActiveDirectory"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "AuthenticationType",
            "modelAsString": true
          }
        },
        "resourceId": {
          "description": "The resource ID of the Data Box Edge/Gateway device.",
          "type": "string",
          "readOnly": true
        },
        "aadAuthority": {
          "description": "Azure Active Directory tenant authority.",
          "type": "string",
          "readOnly": true
        },
        "aadTenantId": {
          "description": "Azure Active Directory tenant ID.",
          "type": "string",
          "readOnly": true
        },
        "servicePrincipalClientId": {
          "description": "Azure Active Directory service principal client ID.",
          "type": "string",
          "readOnly": true
        },
        "servicePrincipalObjectId": {
          "description": "Azure Active Directory service principal object ID.",
          "type": "string",
          "readOnly": true
        },
        "azureManagementEndpointAudience": {
          "description": "The azure management endpoint audience.",
          "type": "string",
          "readOnly": true
        },
        "aadAudience": {
          "description": "Identifier of the target resource that is the recipient of the requested token.",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "User": {
      "description": "Represents a user who has access to one or more shares on the Data Box Edge/Gateway device.",
      "required": [
        "properties"
      ],
      "type": "object",
      "allOf": [
        {
          "$ref": "#/definitions/ARMBaseModel"
        }
      ],
      "properties": {
        "systemData": {
          "description": "User in DataBoxEdge Resource",
          "$ref": "#/definitions/SystemData"
        },
        "properties": {
          "$ref": "#/definitions/UserProperties",
          "description": "The storage account credential properties.",
          "x-ms-client-flatten": true
        }
      }
    },
    "UserAccessRight": {
      "description": "The mapping between a particular user and the access type on the SMB share.",
      "required": [
        "userId",
        "accessType"
      ],
      "type": "object",
      "properties": {
        "userId": {
          "description": "User ID (already existing in the device).",
          "type": "string"
        },
        "accessType": {
          "description": "Type of access to be allowed for the user.",
          "enum": [
            "Change",
            "Read",
            "Custom"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "ShareAccessType",
            "modelAsString": true
          }
        }
      }
    },
    "UserList": {
      "description": "Collection of users.",
      "type": "object",
      "properties": {
        "value": {
          "description": "The list of users.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/User"
          },
          "readOnly": true
        },
        "nextLink": {
          "description": "Link to the next set of results.",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "UserProperties": {
      "description": "The user properties.",
      "type": "object",
      "properties": {
        "encryptedPassword": {
          "$ref": "#/definitions/AsymmetricEncryptedSecret",
          "description": "The password details."
        },
        "shareAccessRights": {
          "description": "List of shares that the user has rights on. This field should not be specified during user creation.",
          "uniqueItems": false,
          "type": "array",
          "items": {
            "$ref": "#/definitions/ShareAccessRight"
          },
          "readOnly": true
        },
        "userType": {
          "description": "Type of the user.",
          "enum": [
            "Share",
            "LocalManagement",
            "ARM"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "UserType",
            "modelAsString": true
          }
        }
      }
    }
  },
  "parameters": {
    "apiVersionParameter": {
      "name": "api-version",
      "in": "query",
      "description": "The API version.",
      "required": true,
      "type": "string"
    },
    "locationParameter": {
      "name": "location",
      "in": "path",
      "description": "The location of the resource.",
      "required": true,
      "type": "string",
      "x-ms-parameter-location": "method"
    },
    "resourceGroupNameParameter": {
      "name": "resourceGroupName",
      "in": "path",
      "description": "The resource group name.",
      "required": true,
      "type": "string",
      "x-ms-parameter-location": "method"
    },
    "subscriptionIdParameter": {
      "name": "subscriptionId",
      "in": "path",
      "description": "The subscription ID.",
      "required": true,
      "type": "string"
    }
  },
  "securityDefinitions": {
    "azure_auth": {
      "flow": "implicit",
      "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
      "scopes": {
        "user_impersonation": "impersonate your user account"
      },
      "type": "oauth2",
      "description": "Azure Active Directory OAuth2 Flow"
    }
  },
  "security": [
    {
      "azure_auth": [
        "user_impersonation"
      ]
    }
  ],
  "tags": []
}